bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (#3272)

Also provide a solution if the user wants to keep multiple blank lines.
This commit is contained in:
Elena Oat 2017-09-07 23:06:45 +03:00 committed by R. David Murray
parent 05f01d8525
commit 397c467c49
1 changed files with 3 additions and 1 deletions

View File

@ -426,7 +426,9 @@ should not be line-wrapped::
-h, --help show this help message and exit -h, --help show this help message and exit
:class:`RawTextHelpFormatter` maintains whitespace for all sorts of help text, :class:`RawTextHelpFormatter` maintains whitespace for all sorts of help text,
including argument descriptions. including argument descriptions. However, multiple new lines are replaced with
one. If you wish to preserve multiple blank lines, add spaces between the
newlines.
:class:`ArgumentDefaultsHelpFormatter` automatically adds information about :class:`ArgumentDefaultsHelpFormatter` automatically adds information about
default values to each of the argument help messages:: default values to each of the argument help messages::