grammar improvements in quickstart.md #4150
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
minrk
added
documentation
outreachy-dec22
minrk
reviewed
Oct 21, 2022
docs/source/quickstart.md
Outdated
| @@ -17,7 +17,7 @@ Before installing JupyterHub, you will need: | |||
|
|
|||
| - If you are using **`pip`**, install a recent version of | |||
| [nodejs/npm](https://docs.npmjs.com/getting-started/installing-node). | |||
| For example, install it on Linux (Debian/Ubuntu) using: | |||
| For example, install it on Linux (Debian/Ubuntu) using the following: | |||
There was a problem hiding this comment.
I don't think it's beneficial to add the following when a code block fits into the flow of a sentence, e.g. "install it...using: [code block]". Adding following is helpful when it's further removed from the code block, as in
Running the following code will do such and such:
I know we've been incosistent with this, but I'd like to mostly move away from habitual "with the following:"
There was a problem hiding this comment.
Suggested change
| For example, install it on Linux (Debian/Ubuntu) using the following: | |
| For example, install it on Linux (Debian/Ubuntu) using: |
Modified some grammar issues.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modified some grammar issues.