From: Georg Brandl <georg@python.org>
Date: Sun, 6 Oct 2013 16:51:39 +0000 (+0200)
Subject: Closes #11807: document argparse add_subparsers method better.
X-Git-Tag: v2.7.6rc1~69
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1f94b26cbafa25713051fc2f5dbc2c7fedb13d20;p=python

Closes #11807: document argparse add_subparsers method better.

Patch by Filip Gruszczyński.
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index a1d58c0b8e..28ecee9e10 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1432,7 +1432,10 @@ Other utilities
 Sub-commands
 ^^^^^^^^^^^^
 
-.. method:: ArgumentParser.add_subparsers()
+.. method:: ArgumentParser.add_subparsers([title], [description], [prog], \
+                                          [parser_class], [action], \
+                                          [option_string], [dest], [help], \
+                                          [metavar])
 
    Many programs split up their functionality into a number of sub-commands,
    for example, the ``svn`` program can invoke sub-commands like ``svn
@@ -1446,6 +1449,30 @@ Sub-commands
    command name and any :class:`ArgumentParser` constructor arguments, and
    returns an :class:`ArgumentParser` object that can be modified as usual.
 
+   Description of parameters:
+
+   * title - title for the sub-parser group in help output; by default
+     "subcommands" if description is provided, otherwise uses title for
+     positional arguments
+
+   * description - description for the sub-parser group in help output, by
+     default None
+
+   * prog - usage information that will be displayed with sub-command help,
+     by default the name of the program and any positional arguments before the
+     subparser argument
+
+   * parser_class - class which will be used to create sub-parser instances, by
+     default the class of the current parser (e.g. ArgumentParser)
+
+   * dest - name of the attribute under which sub-command name will be
+     stored; by default None and no value is stored
+
+   * help - help for sub-parser group in help output, by default None
+
+   * metavar - string presenting available sub-commands in help; by default it
+     is None and presents sub-commands in form {cmd1, cmd2, ..}
+
    Some example usage::
 
      >>> # create the top-level parser