-
Notifications
You must be signed in to change notification settings - Fork 74
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
Remove prefixed $ from shell command examples #610
Remove prefixed $ from shell command examples #610
Conversation
The prefixed $ makes it impossible to simply copy and paste the examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We did a very similar thing for one of our internal docs so I think this change makes total sense 👍
Just in case let's wait for someone else's opinion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, LGTM!
I don't know because while it makes copying more easy with triple-click selection, it also makes it less clear that these are commands to type at the shell prompt… Also it's the default from bundler generated gems for instance, so I don't think people are too confused: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes that's what I meant by triple-clicking, this PR makes it much more useful. The copy button is similar in that regard. Ok I'm convinced!
While we're at it, can we change all the bash
into sh-session
?
Sure thing. Done! (feel free to merge this if it looks good on your end) |
As the prefixed
$
makes it impossible to copy and paste example shell commands, I was thinking it might be beneficial to remove them from the README. What do y'all think?