[Python-checkins] r46860 - in python/trunk: Doc/lib/liboptparse.tex Misc/NEWS

[greg.ward]

Author: greg.ward
Date: Sun Jun 11 16:42:41 2006
New Revision: 46860

Modified:
   python/trunk/Doc/lib/liboptparse.tex
   python/trunk/Misc/NEWS
Log:
SF #1366250: optparse docs: fix inconsistency in variable name; minor tweaks.

Modified: python/trunk/Doc/lib/liboptparse.tex
==============================================================================
--- python/trunk/Doc/lib/liboptparse.tex	(original)
+++ python/trunk/Doc/lib/liboptparse.tex	Sun Jun 11 16:42:41 2006
@@ -1197,16 +1197,16 @@
 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 @@
 \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

Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Sun Jun 11 16:42:41 2006
@@ -145,6 +145,8 @@
 Library
 -------
 
+- Bug #1366250: minor optparse documentation error.
+
 - Bug #1361643: fix textwrap.dedent() so it handles tabs appropriately;
   clarify docs.