Issue #13605: add documentation for nargs=argparse.REMAINDER

1 files changed, 11 insertions, 0 deletions

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 28537e9..a1ddfc9 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -840,6 +840,17 @@ values are:
      usage: PROG [-h] foo [foo ...]
      PROG: error: too few arguments
 
+* ``argparse.REMAINDER``.  All the remaining command-line arguments
+  are gathered into a lits. This is commonly useful for command line
+  utilities that dispatch to other command line utilities.
+
+     >>> parser = argparse.ArgumentParser(prog='PROG')
+     >>> parser.add_argument('--foo')
+     >>> parser.add_argument('command')
+     >>> parser.add_argument('args', nargs=argparse.REMAINDER)
+     >>> print parser.parse_args('--foo B XX YY ZZ'.split())
+     Namespace(args=['YY', 'ZZ'], command='XX', foo='B')
+
 If the ``nargs`` keyword argument is not provided, the number of arguments consumed
 is determined by the action_.  Generally this means a single command-line argument
 will be consumed and a single item (not a list) will be produced.