summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2011-04-21 13:12:17 (GMT)
committerEzio Melotti <ezio.melotti@gmail.com>2011-04-21 13:12:17 (GMT)
commit0ee9c1be76882604cce078791f8a92e126c7c164 (patch)
tree1c840aa29686570928384c6cd4e2fc68d63f7223 /Doc
parentcca4ef8cbadbc4be3906b2f349776ff98acc526e (diff)
downloadcpython-0ee9c1be76882604cce078791f8a92e126c7c164.zip
cpython-0ee9c1be76882604cce078791f8a92e126c7c164.tar.gz
cpython-0ee9c1be76882604cce078791f8a92e126c7c164.tar.bz2
Add the :mod: role where it was missing.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/argparse.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 93d7647..9f2afa8 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -981,7 +981,7 @@ etc. are all supported.
required
^^^^^^^^
-In general, the argparse module assumes that flags like ``-f`` and ``--bar``
+In general, the :mod:`argparse` module assumes that flags like ``-f`` and ``--bar``
indicate *optional* arguments, which can always be omitted at the command line.
To make an option *required*, ``True`` can be specified for the ``required=``
keyword argument to :meth:`add_argument`::
@@ -1601,9 +1601,9 @@ Mutual exclusion
.. method:: add_mutually_exclusive_group(required=False)
- Create a mutually exclusive group. argparse will make sure that only one of
- the arguments in the mutually exclusive group was present on the command
- line::
+ Create a mutually exclusive group. :mod:`argparse` will make sure that only
+ one of the arguments in the mutually exclusive group was present on the
+ command line::
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_exclusive_group()
@@ -1770,14 +1770,14 @@ Exiting methods
Upgrading optparse code
-----------------------
-Originally, the argparse module had attempted to maintain compatibility with
-optparse. However, optparse was difficult to extend transparently, particularly
-with the changes required to support the new ``nargs=`` specifiers and better
-usage messages. When most everything in optparse had either been copy-pasted
-over or monkey-patched, it no longer seemed practical to try to maintain the
-backwards compatibility.
+Originally, the mod:`argparse` module had attempted to maintain compatibility
+with :mod:`optparse`. However, :mod:`optparse` was difficult to extend
+transparently, particularly with the changes required to support the new
+``nargs=`` specifiers and better usage messages. When most everything in
+:mod:`optparse` had either been copy-pasted over or monkey-patched, it no
+longer seemed practical to try to maintain the backwards compatibility.
-A partial upgrade path from optparse to argparse:
+A partial upgrade path from :mod:`optparse` to :mod:`argparse`:
* Replace all ``add_option()`` calls with :meth:`ArgumentParser.add_argument`
calls.