summaryrefslogtreecommitdiffstats
path: root/Doc/library/argparse.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/argparse.rst')
-rw-r--r--Doc/library/argparse.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 305a546..12684db 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1051,6 +1051,17 @@ specifiers include the program name, ``%(prog)s`` and most keyword arguments to
optional arguments:
-h, --help show this help message and exit
+:mod:`argparse` supports silencing the help entry for certain options, by
+setting the ``help`` value to ``argparse.SUPPRESS``::
+
+ >>> parser = argparse.ArgumentParser(prog='frobble')
+ >>> parser.add_argument('--foo', help=argparse.SUPPRESS)
+ >>> parser.print_help()
+ usage: frobble [-h]
+
+ optional arguments:
+ -h, --help show this help message and exit
+
metavar
^^^^^^^