diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2017-09-07 21:18:45 (GMT) |
|---|---|---|
| committer | R. David Murray <rdmurray@bitdance.com> | 2017-09-07 21:18:45 (GMT) |
| commit | e89b35dd2b87e85978b91e3e2dbdea1fc76d6be4 (patch) | |
| tree | 188bc4e16b3104d2a4a963bfd299965f2d2fb6c0 /Doc/library | |
| parent | 76006f285a7e146484d9296597d1d0ace778f992 (diff) | |
| download | cpython-e89b35dd2b87e85978b91e3e2dbdea1fc76d6be4.zip cpython-e89b35dd2b87e85978b91e3e2dbdea1fc76d6be4.tar.gz cpython-e89b35dd2b87e85978b91e3e2dbdea1fc76d6be4.tar.bz2 | |
[3.6] bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (GH-3272) (GH-3429)
Also provide a solution if the user wants to keep multiple blank lines.
(cherry picked from commit 397c467c49385023de36411194d381ac993bae1a)
Diffstat (limited to 'Doc/library')
| -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 4530304..9411bbd 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:: |