-
Notifications
You must be signed in to change notification settings - Fork 129
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Improve help text of CLI command descriptions #313
Comments
This can be done by changing out the help formatter class used by augur's argparse instance. |
I think there's an example of that in the nextstrain/cli code. |
The most basic fix, preserving paragraphs and line wrapping and whitespace, is ensuring that More extensive improvements would include rendering the rST in these docstrings/descriptions to plain text for use in I've done that and a lot of other prior work in Nextstrain CLI's usage of argparse to keep command descriptions readable, including limiting wrapping widths. |
Actually, #1630 is not a duplicate if we scope this issue to descriptions and not all CLI help text. Much more work is needed to improve help text for options, so I think we can treat that as separate. I'll update the issue titles/descriptions to reflect this scoping. |
Currently the formatting of the help messages (defined via the leading docstrings at the start of each script in
augur/*.py
) is not respected byaugur <command> --help
. We should improve this which will encourage more detailed help messages. Note that read-the-docs formats things correctly 💯Example:
augur distance
Docstring correctly formatted -- see https://nextstrain-augur.readthedocs.io/en/stable/cli.html#distance
Incorrect formatting:
Possible solutions
The text was updated successfully, but these errors were encountered: