Enhance README/lib.rs with advanced command description examples#215
Enhance README/lib.rs with advanced command description examples#215fadeevab wants to merge 3 commits intogoogle:masterfrom
Conversation
|
The advanced description and the Examples section have been supported by |
|
@erickt Hi, could you please check this out! Thanks! |
fadeevab
changed the title
|
@benbrittain @erickt Thank you for your review in advance! P.S.: I've already improved the README 6 years ago - PR #16 😄 |
erickt
left a comment
erickt
left a comment
There was a problem hiding this comment.
Otherwise looks good, thanks!
README.md
Outdated
| goup --height 5 --pilot-nickname Wes jump | ||
| ``` | ||
|
|
||
| ## Note |
There was a problem hiding this comment.
Could you leave this section on the bottom?
There was a problem hiding this comment.
Done, I moved it to the end of README!
Could you also check my other PR 🥹 #216 ... It enables flexible placing of top-level arguments.
There was a problem hiding this comment.
Let's merge this one?
2 participants
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?)