(original) (raw)
changeset: 74242:572ddf2770bc branch: 3.2 parent: 74233:cc346a672091 user: Sandro Tosi sandro.tosi@gmail.com date: Tue Jan 03 18:37:03 2012 +0100 files: Doc/library/argparse.rst description: Issue #9349: add argparse.SUPPRESS to help doc diff -r cc346a672091 -r 572ddf2770bc Doc/library/argparse.rst --- a/Doc/library/argparse.rst Mon Jan 02 15:47:29 2012 +0100 +++ b/Doc/library/argparse.rst Tue Jan 03 18:37:03 2012 +0100 @@ -1051,6 +1051,17 @@ 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 ^^^^^^^ /sandro.tosi@gmail.com