atof() description: Add information about accepting 'NaN' to produce

the NaN value.
This commit is contained in:
Fred Drake 1999-02-18 03:49:20 +00:00
parent 594b3d66bd
commit 951eea4733
2 changed files with 12 additions and 9 deletions

View File

@ -231,12 +231,13 @@ removed.
\begin{funcdesc}{float}{x} \begin{funcdesc}{float}{x}
Convert a string or a number to floating point. If the argument is a Convert a string or a number to floating point. If the argument is a
string, it must contain a possibly signed decimal or floating point string, it must contain a possibly signed decimal or floating point
number, possibly embedded in whitespace; number, possibly embedded in whitespace, or be \code{'NaN'} (case
this behaves identical to \code{string.atof(\var{x})}. insensitive); this behaves identical to
Otherwise, the argument may be a plain or \code{string.atof(\var{x})}. If the string is \code{'NaN'}, the
long integer or a floating point number, and a floating point number IEEE ``Not a Number'' value is returned. Otherwise, the argument
with the same value (within Python's floating point precision) is may be a plain or long integer or a floating point number, and a
returned. floating point number with the same value (within Python's floating
point precision) is returned.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{getattr}{object, name} \begin{funcdesc}{getattr}{object, name}

View File

@ -59,9 +59,11 @@ The functions defined in this module are:
\begin{funcdesc}{atof}{s} \begin{funcdesc}{atof}{s}
Convert a string to a floating point number. The string must have Convert a string to a floating point number. The string must have
the standard syntax for a floating point literal in Python, the standard syntax for a floating point literal in Python,
optionally preceded by a sign (\samp{+} or \samp{-}). Note that optionally preceded by a sign (\samp{+} or \samp{-}), or be
this behaves identical to the built-in function \code{'NaN'} (case insensitive) to indicate the IEEE ``Not a
\function{float()}\bifuncindex{float} when passed a string. Number'' value. Note that this behaves identical to the built-in
function \function{float()}\bifuncindex{float} when passed a
string.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{s\optional{, base}} \begin{funcdesc}{atoi}{s\optional{, base}}