From d1c797e624c26ae99fe1691cf5da73261034a383 Mon Sep 17 00:00:00 2001 From: Greg Ward Date: Sun, 11 Jun 2006 14:42:41 +0000 Subject: [PATCH] SF #1366250: optparse docs: fix inconsistency in variable name; minor tweaks. --- Doc/lib/liboptparse.tex | 14 +++++++------- Misc/NEWS | 2 ++ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/Doc/lib/liboptparse.tex b/Doc/lib/liboptparse.tex index 6f12295465..e50247ab4a 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 diff --git a/Misc/NEWS b/Misc/NEWS index 80e6d95a8d..579f9406b4 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -145,6 +145,8 @@ Extension Modules Library ------- +- Bug #1366250: minor optparse documentation error. + - Bug #1361643: fix textwrap.dedent() so it handles tabs appropriately; clarify docs. -- 2.40.0