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

Include description to subparser help text #39

Open
ewu63 opened this issue May 7, 2021 · 0 comments
Open

Include description to subparser help text #39

ewu63 opened this issue May 7, 2021 · 0 comments

Comments

@ewu63
Copy link
Collaborator

ewu63 commented May 7, 2021

Description

The add_subparsers function accepts both help and description. My understanding is that help is displayed at the main parser level, and description is a longer..description displayed at the subparser level. It would be good to have both shown, and we can do this by defining the help string as a variable, then appending to it some more detailed description and passing that to description=.

Note that this has certain implications if we plan to add sphinx documentation and use autoprogram or equivalent to document the CLI.

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

No branches or pull requests

1 participant