summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSenthil Kumaran <senthil@uthcode.com>2012-06-26 06:17:19 (GMT)
committerSenthil Kumaran <senthil@uthcode.com>2012-06-26 06:17:19 (GMT)
commitf21804ad61af980cd6659ca8471b111675b9d20c (patch)
treed406d882e5017f03c70aa1c94ebbb8ed01b53385
parent3e6d71d3360f2b8dd0232b492d0a63cc6b5419d3 (diff)
downloadcpython-f21804ad61af980cd6659ca8471b111675b9d20c.zip
cpython-f21804ad61af980cd6659ca8471b111675b9d20c.tar.gz
cpython-f21804ad61af980cd6659ca8471b111675b9d20c.tar.bz2
Issue #13685 - Update argparse help message for % sign usage.
-rw-r--r--Doc/library/argparse.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 186e12d..d64f8a2 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1082,6 +1082,9 @@ specifiers include the program name, ``%(prog)s`` and most keyword arguments to
optional arguments:
-h, --help show this help message and exit
+As the help string supports %-formatting, if you want a literal ``%`` to appear
+in the help string, you must escape it as ``%%``.
+
:mod:`argparse` supports silencing the help entry for certain options, by
setting the ``help`` value to ``argparse.SUPPRESS``::