Commits

Fred Drake committed b30077c

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

Comments (0)

Files changed (2)

Doc/lib/libfuncs.tex

 \begin{funcdesc}{float}{x}
   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
-  number, possibly embedded in whitespace;
-  this behaves identical to \code{string.atof(\var{x})}.
-  Otherwise, the argument may be a plain or
-  long integer or a floating point number, and a floating point number
-  with the same value (within Python's floating point precision) is
-  returned.
+  number, possibly embedded in whitespace, or be \code{'NaN'} (case
+  insensitive); this behaves identical to
+  \code{string.atof(\var{x})}.  If the string is \code{'NaN'}, the
+  IEEE ``Not a Number'' value is returned.  Otherwise, the argument
+  may be a plain or long integer or a floating point number, and a
+  floating point number with the same value (within Python's floating
+  point precision) is returned.
 \end{funcdesc}
 
 \begin{funcdesc}{getattr}{object, name}

Doc/lib/libstring.tex

 \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{-}).  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{-}), 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.
 \end{funcdesc}
 
 \begin{funcdesc}{atoi}{s\optional{, base}}