From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 7 Sep 2017 21:18:45 +0000 (-0700)
Subject: [3.6] bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. ... 
X-Git-Tag: v3.6.3rc1~65
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e89b35dd2b87e85978b91e3e2dbdea1fc76d6be4;p=python

[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)
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 4530304817..9411bbd4ac 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::