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

make rbenv init more visible in the readme #1092

Merged
merged 3 commits into from Jun 7, 2018

Conversation

Projects
None yet
2 participants
@jacobherrington
Contributor

jacobherrington commented Jun 7, 2018

In these two places where the reader is instructed to run rbenv init the command is not broken out from the text like nearly all of the other shell commands. This makes it easy for a reader to miss or misunderstand that rbenv init should be run in shell.

I moved them into a position such that they are now harder to miss and consistent with the rest of the document. Let me know if there are other changes I should make.

Thanks.

@mislav

Thank you for your help!

README.md Outdated
2. Run `rbenv init` and follow the instructions to set up
rbenv integration with your shell. This is the step that will make
running `ruby` "see" the Ruby version that you choose with rbenv.
2. Initialize rbenv.

This comment has been minimized.

@mislav

mislav Jun 7, 2018

Member

“Initialize rbenv” says little on its own. How about “Set up rbenv in your shell”?

README.md Outdated
$ rbenv init
~~~
Follow the instructions to set up rbenv integration with your shell. This

This comment has been minimized.

@mislav

mislav Jun 7, 2018

Member

I know that you mostly preserved old text, but let's take this opportunity to improve it. How about:

Follow the printed instructions to [set up rbenv shell integration](#how-rbenv-hooks-into-your-shell).
@jacobherrington

This comment has been minimized.

Contributor

jacobherrington commented Jun 7, 2018

@mislav made those changes, thanks for the suggestions!

@mislav mislav merged commit 8b18b96 into rbenv:master Jun 7, 2018

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment