Update the description of int() to include the radix parameter;
authorFred Drake <fdrake@acm.org>
Thu, 17 Feb 2000 17:45:52 +0000 (17:45 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 17 Feb 2000 17:45:52 +0000 (17:45 +0000)
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).

Doc/lib/libfuncs.tex

index ae4af6c1904ad647d175d48210e87c39cbb9afd9..b9c03b736c132f587712676da959c571b52c568e 100644 (file)
@@ -312,6 +312,22 @@ module from which it is called).
   Equivalent to \code{eval(raw_input(\var{prompt}))}.
 \end{funcdesc}
 
+\begin{funcdesc}{int}{x\optional{, radix}}
+  Convert a string or number to a plain integer.  If the argument is a
+  string, it must contain a possibly signed decimal number
+  representable as a Python integer, possibly embedded in whitespace;
+  this behaves identical to \code{string.atoi(\var{x}\optional{,
+  \var{radix}})}.  The \var{radix} parameter gives the base for the
+  conversion and may be any integer in the range $[2, 36]$.  If
+  \var{radix} is specified and \var{x} is not a string,
+  \exception{TypeError} is raised.
+  Otherwise, the argument may be a plain or
+  long integer or a floating point number.  Conversion of floating
+  point numbers to integers is defined by the C semantics; normally
+  the conversion truncates towards zero.\footnote{This is ugly --- the
+  language definition should require truncation towards zero.}
+\end{funcdesc}
+
 \begin{funcdesc}{intern}{string}
   Enter \var{string} in the table of ``interned'' strings and return
   the interned string -- which is \var{string} itself or a copy.
@@ -325,18 +341,6 @@ module from which it is called).
   garbage collected).
 \end{funcdesc}
 
-\begin{funcdesc}{int}{x}
-  Convert a string or number to a plain integer.  If the argument is a
-  string, it must contain a possibly signed decimal number
-  representable as a Python integer, possibly embedded in whitespace;
-  this behaves identical to \code{string.atoi(\var{x})}.
-  Otherwise, the argument may be a plain or
-  long integer or a floating point number.  Conversion of floating
-  point numbers to integers is defined by the C semantics; normally
-  the conversion truncates towards zero.\footnote{This is ugly --- the
-  language definition should require truncation towards zero.}
-\end{funcdesc}
-
 \begin{funcdesc}{isinstance}{object, class}
 Return true if the \var{object} argument is an instance of the
 \var{class} argument, or of a (direct or indirect) subclass thereof.