summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorGreg Ward <gward@python.net>2006-06-11 14:42:41 (GMT)
committerGreg Ward <gward@python.net>2006-06-11 14:42:41 (GMT)
commitd1c797e624c26ae99fe1691cf5da73261034a383 (patch)
tree8ff0c03195c849e797a5cf082d2fde9ceee14f8b /Doc/lib
parent19302d927e6688e02553df16177e4867e2d0e3b3 (diff)
downloadcpython-d1c797e624c26ae99fe1691cf5da73261034a383.zip
cpython-d1c797e624c26ae99fe1691cf5da73261034a383.tar.gz
cpython-d1c797e624c26ae99fe1691cf5da73261034a383.tar.bz2
SF #1366250: optparse docs: fix inconsistency in variable name; minor tweaks.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/liboptparse.tex14
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/lib/liboptparse.tex b/Doc/lib/liboptparse.tex
index 6f12295..e50247a 100644
--- a/Doc/lib/liboptparse.tex
+++ b/Doc/lib/liboptparse.tex
@@ -1197,16 +1197,16 @@ its \method{parse{\_}args()} method:
where the input parameters are
\begin{description}
\item[\code{args}]
-the list of arguments to process (\code{sys.argv{[}1:]} by default)
+the list of arguments to process (default: \code{sys.argv{[}1:]})
\item[\code{options}]
-object to store option arguments in (a new instance of
-optparse.Values by default)
+object to store option arguments in (default: a new instance of
+optparse.Values)
\end{description}
and the return values are
\begin{description}
\item[\code{options}]
-the same object as was passed in as \code{options}, or the new
+the same object that was passed in as \code{options}, or the
optparse.Values instance created by \module{optparse}
\item[\code{args}]
the leftover positional arguments after all options have been
@@ -1214,9 +1214,9 @@ processed
\end{description}
The most common usage is to supply neither keyword argument. If you
-supply a \code{values} object, it will be repeatedly modified with a
-\code{setattr()} call for every option argument written to an option
-destination, and finally returned by \method{parse{\_}args()}.
+supply \code{options}, it will be modified with repeated \code{setattr()}
+calls (roughly one for every option argument stored to an option
+destination) and returned by \method{parse{\_}args()}.
If \method{parse{\_}args()} encounters any errors in the argument list, it calls
the OptionParser's \method{error()} method with an appropriate end-user error