fix(help): Clarify short vs long help #4159
Merged
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
In reviewing CLIs for clap-rs#4132, I found some were providing helps on `-h` vs `--help` and figured that could be built directly into clap. I had considered not making this hint automatic but I figured the overhead of checking if long exists wouldn't be too bad. The code exists (no binary size increase) and just a simple iteration is probably not too slow compared to everything else. Fixes clap-rs#1015
This was referenced Oct 20, 2022
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.
In reviewing CLIs for #4132, I found some were providing helps on
-hvs
--helpand figured that could be built directly into clap. I hadconsidered not making this hint automatic but I figured the overhead of
checking if long exists wouldn't be too bad. The code exists (no binary
size increase) and just a simple iteration is probably not too slow
compared to everything else.
If you use
-h, you'll seeIf you use
--help, you'll seeFixes #1015