CLI: Use raw descriptions #1641
Draft
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
This is necessary to register subparsers recursively.
victorlin
force-pushed
the
victorlin/argparse-register-commands
branch
from
3127384
to
51f7dca
Compare
Keeps consistent with Nextstrain CLI.
Set a single source of truth.
victorlin
force-pushed
the
victorlin/argparse-register-commands
branch
from
51f7dca
to
710f804
Compare
This is useful for commands such as `augur distance` which have descriptions written in rST. The rST syntax is preserved and could be removed with a custom formatter class (as done in Nextstrain CLI¹), but simply using the built-in RawDescriptionHelpFormatter is an improvement over the default behavior. Note that this only applies to descriptions, not help text for options. ¹ https://github.com/nextstrain/cli/blob/d4a419626eb5dc64e6de08566e51c5b48814727d/nextstrain/cli/argparse.py#L53
victorlin
force-pushed
the
victorlin/argparse-use-raw-descriptions
branch
from
7966c30
to
dacddeb
Compare
victorlin
force-pushed
the
victorlin/argparse-register-commands
branch
from
710f804
to
f5e9472
Compare
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.
Description of proposed changes
This is useful for commands such as
augur distancewhich have descriptions written in rST. The rST syntax is preserved and could be removed with a custom formatter class (as done in Nextstrain CLI), but simply using the built-in RawDescriptionHelpFormatter is an improvement over the default behavior.Note that this only applies to descriptions, not help text for options.
Related issue(s)
Checklist