Add notes to __builtin__.float() and string.atof() that the NaN and Inf

results are possible but non-portable.
This commit is contained in:
Fred Drake 1999-02-18 16:08:36 +00:00
parent d60ec8f11a
commit 70a66c9d6d
2 changed files with 20 additions and 12 deletions

View file

@ -59,11 +59,15 @@ The functions defined in this module are:
\begin{funcdesc}{atof}{s}
Convert a string to a floating point number. The string must have
the standard syntax for a floating point literal in Python,
optionally preceded by a sign (\samp{+} or \samp{-}), or be
\code{'NaN'} (case insensitive) to indicate the IEEE ``Not a
Number'' value. Note that this behaves identical to the built-in
function \function{float()}\bifuncindex{float} when passed a
string.
optionally preceded by a sign (\samp{+} or \samp{-}). Note that
this behaves identical to the built-in function
\function{float()}\bifuncindex{float} when passed a string.
\strong{Note:} When passing in a string, values for NaN\index{NaN}
and Infinity\index{Infinity} may be returned, depending on the
underlying C library. The specific set of strings accepted which
cause these values to be returned depends entirely on the C library
and is known to vary.
\end{funcdesc}
\begin{funcdesc}{atoi}{s\optional{, base}}