]> granicus.if.org Git - python/commitdiff
SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex)
authorRaymond Hettinger <python@rcn.com>
Thu, 14 Aug 2003 19:58:35 +0000 (19:58 +0000)
committerRaymond Hettinger <python@rcn.com>
Thu, 14 Aug 2003 19:58:35 +0000 (19:58 +0000)
(Contributed by George Yoshida.)

Doc/lib/libcfgparser.tex

index 1f33df42e8f25a92a37697b480c5e253f3847d1f..ad4bbb3d3b5ccb7f2516c3ef5075ee7d013933ab 100644 (file)
@@ -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}