From: Raymond Hettinger Date: Thu, 14 Aug 2003 19:58:35 +0000 (+0000) Subject: SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex) X-Git-Tag: v2.4a1~1744 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fb857893a2a9885bb872f8729d1a4dfc00762134;p=python SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex) (Contributed by George Yoshida.) --- diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex index 1f33df42e8..ad4bbb3d3b 100644 --- a/Doc/lib/libcfgparser.tex +++ b/Doc/lib/libcfgparser.tex @@ -217,10 +217,10 @@ 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 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. These -values are checked in a case-insensitive manner. Any other value will +for the option are \code{"1"}, \code{"yes"}, \code{"true"}, and \code{"on"}, +which cause this method to return \code{True}, and \code{"0"}, \code{"no"}, +\code{"false"}, and \code{"off"}, which cause it to return \code{False}. These +string values are checked in a case-insensitive manner. Any other value will cause it to raise \exception{ValueError}. \end{methoddesc}