Skip to content

Dollar signs in installation section of TRPL can be confusing. #25554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nham opened this issue May 17, 2015 · 3 comments · Fixed by #25882
Closed

Dollar signs in installation section of TRPL can be confusing. #25554

nham opened this issue May 17, 2015 · 3 comments · Fixed by #25882

Comments

@nham
Copy link
Contributor

nham commented May 17, 2015

Currently the Installation section of TRPL displays commands to be typed into the command line with a dollar sign in front, like this:

$ rustc --version

I see that there's a warning that you shouldn't type them, but nevertheless one person was already confused: https://users.rust-lang.org/t/powershell-and-rustc-command/1411

Either the warning should be made more prominent, or the dollar signs should be removed. (Note that in Clojure from the ground up there are no dollar signs, which seems to work well).

cc @steveklabnik

@steveklabnik
Copy link
Member

This has a very, very long history of being how to show command line things. I would prefer something to be more prominent over breaking with history.

@nagisa
Copy link
Member

nagisa commented May 18, 2015

Dollar signs could be added with CSS :before, so it wouldn’t be copy-able. I guess that would shave off another 99% of that 1% of people who blindly copy-paste.

@tshepang
Copy link
Member

Great idea there @nagisa.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants