]> granicus.if.org Git - python/commitdiff
Update the description of getboolean() to reflect the changes made by
authorFred Drake <fdrake@acm.org>
Mon, 8 Oct 2001 16:03:20 +0000 (16:03 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 8 Oct 2001 16:03:20 +0000 (16:03 +0000)
SF patch #467580.

Doc/lib/libcfgparser.tex

index f2137326f15831c6be5a737131b1c17cfc061a53..591df2e942ea2d960dfd67782cef31a2a875d8bd 100644 (file)
@@ -163,9 +163,11 @@ A convenience method which coerces the \var{option} in the specified
 
 \begin{methoddesc}{getboolean}{section, option}
 A convenience method which coerces the \var{option} in the specified
-\var{section} to a Boolean value.  Note that the only accepted values
-for the option are \samp{0} and \samp{1}, any others will raise
-\exception{ValueError}.
+\var{section} to a Boolean value.  Note that the accepted values
+for the option are \code{1}, \code{yes}, \code{true}, and \code{on},
+which cause this method to return true, and \code{0}, \code{no},
+\code{false}, and \code{off}, which cause it to return false.  Any
+other value will cause it to raise \exception{ValueError}.
 \end{methoddesc}
 
 \begin{methoddesc}{set}{section, option, value}