README: Use hsubparser in example code
#500
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
Example code should use `hsubparser` instead of `subparser` because generating good `--help` text is one of the main responsibilities of a CLI argument parsing framework. I was using the example code and found myself very confused that `foo cmd --help` would ignore `cmd` entirely but `foo --help cmd` would work correctly. This behavior is extremely unintuitive and should not be the default.
Collaborator
|
Ta. |
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.
Example code should use
hsubparserinstead ofsubparserbecause generating good--helptext is one of the main responsibilities of a CLI argument parsing framework.I was using the example code and found myself very confused that
foo cmd --helpwould ignorecmdentirely butfoo --help cmdwould work correctly. This behavior is extremely unintuitive and should not be the default.