Print "Usage" w/ rubric before printing the command usage #155
Conversation
This file contains hidden or 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
scottamain
force-pushed
the
print-usage
branch
2 times, most recently
from
bdf6762 to
2049f04
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Add a "Usage" rubric before the printing the command usage, same as the "Options" rubric.
This provides a nice visual separation between the description text and the code showing the usage format, which is especially useful when the introduction is many paragraphs that includes other examples itself.
This is a pretty common format for CLI docs, although a lot of them say "Synopsis" instead, which I believe is a terrible word to use because it’s a very uncommon word.
Tasks
reno)tox)