Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set sub-command cli description #343

Merged
merged 1 commit into from
Jun 28, 2023

Conversation

edward-evans-aiven
Copy link
Contributor

Argparse parsers use description to access the overall help for a command, unlike the add_argument calls which use the help attribute.

Without this, the general description on what a sub-command is to be used for is lost when running with --help

Documentation: https://docs.python.org/3/library/argparse.html#description

`Argparse` parsers use `description` to access the overall help for
a command, unlike the `add_argument` calls which use the `help`
attribute.

Documentation: https://docs.python.org/3/library/argparse.html#description
@edward-evans-aiven edward-evans-aiven requested a review from a team as a code owner June 28, 2023 02:23
@derrix060 derrix060 merged commit 5b05e40 into main Jun 28, 2023
4 of 5 checks passed
@derrix060 derrix060 deleted the display-command-documents-in-cli-help branch June 28, 2023 02:38
edward-evans-aiven added a commit that referenced this pull request Jun 29, 2023
rominf pushed a commit that referenced this pull request Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants