]> granicus.if.org Git - python/commitdiff
Issue #9349: add argparse.SUPPRESS to help doc
authorSandro Tosi <sandro.tosi@gmail.com>
Tue, 3 Jan 2012 17:31:51 +0000 (18:31 +0100)
committerSandro Tosi <sandro.tosi@gmail.com>
Tue, 3 Jan 2012 17:31:51 +0000 (18:31 +0100)
Doc/library/argparse.rst

index 38e3f3ee7a4aa4e696eb77573d3470fdb713bb27..5ad36c7e9fc1d9acef0ff2d39afdbb91606ec0c7 100644 (file)
@@ -1049,6 +1049,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
 ^^^^^^^