chore: improve output of -h/--help
#1268
Merged
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
onbjerg
force-pushed
the
onbjerg/help-improvements
branch
from
0119e2e to
cfb385d
Compare
8 tasks
onbjerg
force-pushed
the
onbjerg/help-improvements
branch
from
749330a to
77cc49f
Compare
onbjerg
force-pushed
the
onbjerg/help-improvements
branch
5 times, most recently
from
2df53f9 to
c684302
Compare
onbjerg
force-pushed
the
onbjerg/help-improvements
branch
from
d7e0f0c to
5b87e90
Compare
mattsse
approved these changes
Apr 14, 2022
Member
mattsse
left a comment
mattsse
left a comment
There was a problem hiding this comment.
lgtm,
like the breakdown of buildargs
| pub force: bool, | ||
| pub via_ir: bool, | ||
|
|
||
| #[clap(flatten, next_help_heading = "PROJECT OPTIONS")] |
Member
There was a problem hiding this comment.
maybe PROJECT LAYOUT/DIR OPTIONS ?
Contributor
Author
There was a problem hiding this comment.
Can do in a follow up PR
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.
Motivation
The output of
-hand--helpis inconsistent and sometimes not super helpful.Solution
Goes through all help text and updates the wording. I also move some of the longer-form help text into
long_helpto shorten the output of-h.I'm going through this as I am rewriting the command references in the book.
Tasks
Walletstruct-h/--help