SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex)
(Contributed by George Yoshida.)
This commit is contained in:
parent
b4f49385a3
commit
fb857893a2
|
@ -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}
|
||||
|
||||
|
|
Loading…
Reference in New Issue