Add description to all subparser helps #359
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
Add the subcommand description to all command subparsers so that any command of the form ramble <command> <subcommand> --help will display the subcommand's doc string below the usage line.
dodecatheon
force-pushed
the
add-description-to-subparser-help
branch
from
4ea4ed9 to
ae9d954
Compare
douglasjacobsen
approved these changes
Dec 19, 2023
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.
Add the subcommand description to all command subparsers so that any command of the form
ramble --help
will display the subcommand's doc string just below the usage line.
For example, 'ramble workspace mirror --help' will show "mirror current workspace state" below
usage.
The subcommand doc string is already available via 'ramble --help' under the
positional argument section, but that usage is not obvious to users unfamiliar with argparse
subcommands, and adding the description increases help output by (usually) only one line
while making the commandline interface more user friendly.