]> granicus.if.org Git - python/commitdiff
#10423: clarify options vs args in argparse discussion of optparse
authorR David Murray <rdmurray@bitdance.com>
Fri, 30 Mar 2012 22:09:07 +0000 (18:09 -0400)
committerR David Murray <rdmurray@bitdance.com>
Fri, 30 Mar 2012 22:09:07 +0000 (18:09 -0400)
Patch by Sandro Tosi.

Doc/library/argparse.rst

index bb7c88de9e2d3977e760b2a945e08589d6631a40..50a453341680e02fbc362a9eb6bfcaa8c5dec8fe 100644 (file)
@@ -1826,9 +1826,10 @@ A partial upgrade path from :mod:`optparse` to :mod:`argparse`:
 * Replace all :meth:`optparse.OptionParser.add_option` calls with
   :meth:`ArgumentParser.add_argument` calls.
 
-* Replace ``options, args = parser.parse_args()`` with ``args =
+* Replace ``(options, args) = parser.parse_args()`` with ``args =
   parser.parse_args()`` and add additional :meth:`ArgumentParser.add_argument`
-  calls for the positional arguments.
+  calls for the positional arguments. Keep in mind that what was previously
+  called ``options``, now in :mod:`argparse` context is called ``args``.
 
 * Replace callback actions and the ``callback_*`` keyword arguments with
   ``type`` or ``action`` arguments.