Skip to content

Commit 7966c30

Browse files
committed
Preserve formatting of command descriptions
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
1 parent db29fe9 commit 7966c30

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Diff for: augur/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def make_parser():
5454
parser = argparse.ArgumentParser(
5555
prog = "augur",
5656
description = "Augur: A bioinformatics toolkit for phylogenetic analysis.",
57-
formatter_class = argparse.ArgumentDefaultsHelpFormatter,
57+
formatter_class = argparse.RawDescriptionHelpFormatter,
5858
)
5959

6060
add_default_command(parser)

0 commit comments

Comments
 (0)