diff options
| author | Elena Oat <oat.elena@gmail.com> | 2017-09-07 23:06:45 +0300 |
|---|---|---|
| committer | R. David Murray <rdmurray@bitdance.com> | 2017-09-07 16:06:45 -0400 |
| commit | 397c467c49385023de36411194d381ac993bae1a (patch) | |
| tree | ab83a60d360f8e082f9fee62e11406e368ba17d5 | |
| parent | 05f01d85257d0f3409c7335aaf0bf6a6da7eecb7 (diff) | |
| download | cpython-git-397c467c49385023de36411194d381ac993bae1a.tar.gz | |
bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (#3272)
Also provide a solution if the user wants to keep multiple blank lines.
| -rw-r--r-- | Doc/library/argparse.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index ab4bc92e5b..c425be6d48 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -426,7 +426,9 @@ should not be line-wrapped:: -h, --help show this help message and exit :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 default values to each of the argument help messages:: |