diff options
author | Fred Drake <fdrake@acm.org> | 2001-10-08 16:03:20 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-10-08 16:03:20 (GMT) |
commit | b35f0ce2b82ff3ffe8f1b961557af3cbebf88da7 (patch) | |
tree | 76e9c829a4a9c3d070c0e9db00f4f7e964ce9dcd /Doc/lib/libcfgparser.tex | |
parent | a0472f73e6f0a0abfae1b3358410fa442471c87a (diff) | |
download | cpython-b35f0ce2b82ff3ffe8f1b961557af3cbebf88da7.zip cpython-b35f0ce2b82ff3ffe8f1b961557af3cbebf88da7.tar.gz cpython-b35f0ce2b82ff3ffe8f1b961557af3cbebf88da7.tar.bz2 |
Update the description of getboolean() to reflect the changes made by
SF patch #467580.
Diffstat (limited to 'Doc/lib/libcfgparser.tex')
-rw-r--r-- | Doc/lib/libcfgparser.tex | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex index f213732..591df2e 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} |