Enhance README/lib.rs with advanced command description examples#215
Merged
Conversation
Contributor
Author
|
The advanced description and the Examples section have been supported by |
Contributor
Author
|
@erickt Hi, could you please check this out! Thanks! |
fadeevab
changed the title
Contributor
Author
|
@benbrittain @erickt Thank you for your review in advance! P.S.: I've already improved the README 6 years ago - PR #16 😄 |
erickt
requested changes
Feb 20, 2026
erickt
left a comment
erickt
left a comment
Collaborator
There was a problem hiding this comment.
Otherwise looks good, thanks!
Contributor
Author
|
@erickt I fixed the warning and |
erickt
approved these changes
Mar 4, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improve documentation with the advanced examples of the top-level command "description" (for the help output).
The short variant of a subcommand is reflected in the documentation and the examples.
NOTE: filename
examples/goup.rs(GoUp) is chosen to make thehelpoutput compelling via the{command_name}placeholder (maybego-up.rs?)