From: Fred Drake <fdrake@acm.org>
Date: Mon, 8 Oct 2001 16:03:20 +0000 (+0000)
Subject: Update the description of getboolean() to reflect the changes made by
X-Git-Tag: v2.2.1c1~1396
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b35f0ce2b82ff3ffe8f1b961557af3cbebf88da7;p=python

Update the description of getboolean() to reflect the changes made by
SF patch #467580.
---

diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index f2137326f1..591df2e942 100644
--- a/Doc/lib/libcfgparser.tex
+++ b/Doc/lib/libcfgparser.tex
@@ -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}