mirror of https://github.com/python/cpython
Update the description of getboolean() to reflect the changes made by
SF patch #467580.
This commit is contained in:
parent
a0472f73e6
commit
b35f0ce2b8
|
@ -163,9 +163,11 @@ A convenience method which coerces the \var{option} in the specified
|
||||||
|
|
||||||
\begin{methoddesc}{getboolean}{section, option}
|
\begin{methoddesc}{getboolean}{section, option}
|
||||||
A convenience method which coerces the \var{option} in the specified
|
A convenience method which coerces the \var{option} in the specified
|
||||||
\var{section} to a Boolean value. Note that the only accepted values
|
\var{section} to a Boolean value. Note that the accepted values
|
||||||
for the option are \samp{0} and \samp{1}, any others will raise
|
for the option are \code{1}, \code{yes}, \code{true}, and \code{on},
|
||||||
\exception{ValueError}.
|
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}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{set}{section, option, value}
|
\begin{methoddesc}{set}{section, option, value}
|
||||||
|
|
Loading…
Reference in New Issue