From: Elena Oat <oat.elena@gmail.com>
Date: Thu, 7 Sep 2017 20:06:45 +0000 (+0300)
Subject: bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (#3272)
X-Git-Tag: v3.7.0a1~114
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=397c467c49385023de36411194d381ac993bae1a;p=python

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

Also provide a solution if the user wants to keep multiple blank lines.
---

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::