Improve help texts #1214
Merged
Improve help texts #1214
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
Some help texts show shell commands for the user to execute and most of the commands were prefixed with the traditional '$ ' shell prompt. Others were presented as if the text would be interpreted as Markdown. The shell commands are now consistently formatted with a '$ ' prompt without any distracting backpings.
Since the output is sent to a terminal, the Markdown used should be chosen to look good in a terminal.
To my ears, the shell command doesn't stop the first sentence, it merely interrupts it. So the second part should not start capitalized.
Sentences are now properly terminated with a full stop and the shell command lines are now mostly introduced with a ':' for consistency.
|
Thanks! |
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.
This PR fixes some small inconsistencies in the help texts.