From 397c467c49385023de36411194d381ac993bae1a Mon Sep 17 00:00:00 2001 From: Elena Oat Date: Thu, 7 Sep 2017 23:06:45 +0300 Subject: [PATCH] bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. (#3272) Also provide a solution if the user wants to keep multiple blank lines. --- Doc/library/argparse.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index ab4bc92e5bd..c425be6d481 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::