Fix usage string for invoke_without_command groups to mark subcommand as optional#3271
Open
siddmoparti wants to merge 2 commits intopallets:mainfrom
Open
Fix usage string for invoke_without_command groups to mark subcommand as optional#3271siddmoparti wants to merge 2 commits intopallets:mainfrom
siddmoparti wants to merge 2 commits intopallets:mainfrom
Conversation
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
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.
Fixes #3059
When a group is created with
invoke_without_command=True, the help usage string currently shows:which incorrectly implies that a subcommand is required. However, in this configuration, the group can be invoked without a subcommand.
This change updates the default
subcommand_metavarso that the usage string correctly reflects optional behavior:The change is limited to non-chain groups with
invoke_without_command=True, and does not affect existing behavior for other group configurations.A regression test has been added to verify that the usage output includes
[COMMAND] [ARGS]...when--helpis invoked.Let me know if any adjustments are needed.