Add cross-refs for int() to atoi() etc.

Change replace() arguments; remove replace1().
This commit is contained in:
Guido van Rossum 1997-04-02 05:56:16 +00:00
parent 21aa0ef351
commit 740eb8265f
2 changed files with 28 additions and 30 deletions

View File

@ -58,7 +58,8 @@ 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, optionally the standard syntax for a floating point literal in Python, optionally
preceded by a sign (\samp{+} or \samp{-}). preceded by a sign (\samp{+} or \samp{-}). Note that this behaves
identical to the built-in function \code{float()} when passed a string.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{s\optional{\, base}} \begin{funcdesc}{atoi}{s\optional{\, base}}
@ -68,9 +69,11 @@ sign (\samp{+} or \samp{-}). The \var{base} defaults to 10. If it is
0, a default base is chosen depending on the leading characters of the 0, a default base is chosen depending on the leading characters of the
string (after stripping the sign): \samp{0x} or \samp{0X} means 16, string (after stripping the sign): \samp{0x} or \samp{0X} means 16,
\samp{0} means 8, anything else means 10. If \var{base} is 16, a \samp{0} means 8, anything else means 10. If \var{base} is 16, a
leading \samp{0x} or \samp{0X} is always accepted. (Note: for a more leading \samp{0x} or \samp{0X} is always accepted. Note that when
flexible interpretation of numeric literals, use the built-in function invoked without \var{base} or with \var{base} set to 10, this behaves
\code{eval()}.) identical to the built-in function \code{int()} when passed a string.
(Also note: for a more flexible interpretation of numeric literals,
use the built-in function \code{eval()}.)
\bifuncindex{eval} \bifuncindex{eval}
\end{funcdesc} \end{funcdesc}
@ -79,7 +82,9 @@ Convert string \var{s} to a long integer in the given \var{base}. The
string must consist of one or more digits, optionally preceded by a string must consist of one or more digits, optionally preceded by a
sign (\samp{+} or \samp{-}). The \var{base} argument has the same sign (\samp{+} or \samp{-}). The \var{base} argument has the same
meaning as for \code{atoi()}. A trailing \samp{l} or \samp{L} is not meaning as for \code{atoi()}. A trailing \samp{l} or \samp{L} is not
allowed, except if the base is 0. allowed, except if the base is 0. Note that when invoked without
\var{base} or with \var{base} set to 10, this behaves identical to the
built-in function \code{long()} when passed a string.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{capitalize}{word} \begin{funcdesc}{capitalize}{word}
@ -227,17 +232,11 @@ Pad a numeric string on the left with zero digits until the given
width is reached. Strings starting with a sign are handled correctly. width is reached. Strings starting with a sign are handled correctly.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{replace}{old, new, str} \begin{funcdesc}{replace}{str, old, new\optional{, maxsplit}}
Return a copy of string \var{str} with all occurrences of substring Return a copy of string \var{str} with all occurrences of substring
\var{old} replaced by \var{new}. \var{old} replaced by \var{new}. If the optional argument
\end{funcdesc} \var{maxsplit} is given, the first \var{maxsplit} occurrences are
replaced.
\begin{funcdesc}{replace1}{old, new, str\optional{, start\optional{, end}}}
Return a copy of string \var{str} with the first occurrence of
substring \var{old} replaced by \var{new}. If no occurrence is found,
\var{str} is returned unchanged. Optional arguments \var{start} and
\var{end} limit the search for \var{old} like for \code{find} (they
are not used to slice the result).
\end{funcdesc} \end{funcdesc}
This module is implemented in Python. Much of its functionality has This module is implemented in Python. Much of its functionality has

View File

@ -58,7 +58,8 @@ 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, optionally the standard syntax for a floating point literal in Python, optionally
preceded by a sign (\samp{+} or \samp{-}). preceded by a sign (\samp{+} or \samp{-}). Note that this behaves
identical to the built-in function \code{float()} when passed a string.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{s\optional{\, base}} \begin{funcdesc}{atoi}{s\optional{\, base}}
@ -68,9 +69,11 @@ sign (\samp{+} or \samp{-}). The \var{base} defaults to 10. If it is
0, a default base is chosen depending on the leading characters of the 0, a default base is chosen depending on the leading characters of the
string (after stripping the sign): \samp{0x} or \samp{0X} means 16, string (after stripping the sign): \samp{0x} or \samp{0X} means 16,
\samp{0} means 8, anything else means 10. If \var{base} is 16, a \samp{0} means 8, anything else means 10. If \var{base} is 16, a
leading \samp{0x} or \samp{0X} is always accepted. (Note: for a more leading \samp{0x} or \samp{0X} is always accepted. Note that when
flexible interpretation of numeric literals, use the built-in function invoked without \var{base} or with \var{base} set to 10, this behaves
\code{eval()}.) identical to the built-in function \code{int()} when passed a string.
(Also note: for a more flexible interpretation of numeric literals,
use the built-in function \code{eval()}.)
\bifuncindex{eval} \bifuncindex{eval}
\end{funcdesc} \end{funcdesc}
@ -79,7 +82,9 @@ Convert string \var{s} to a long integer in the given \var{base}. The
string must consist of one or more digits, optionally preceded by a string must consist of one or more digits, optionally preceded by a
sign (\samp{+} or \samp{-}). The \var{base} argument has the same sign (\samp{+} or \samp{-}). The \var{base} argument has the same
meaning as for \code{atoi()}. A trailing \samp{l} or \samp{L} is not meaning as for \code{atoi()}. A trailing \samp{l} or \samp{L} is not
allowed, except if the base is 0. allowed, except if the base is 0. Note that when invoked without
\var{base} or with \var{base} set to 10, this behaves identical to the
built-in function \code{long()} when passed a string.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{capitalize}{word} \begin{funcdesc}{capitalize}{word}
@ -227,17 +232,11 @@ Pad a numeric string on the left with zero digits until the given
width is reached. Strings starting with a sign are handled correctly. width is reached. Strings starting with a sign are handled correctly.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{replace}{old, new, str} \begin{funcdesc}{replace}{str, old, new\optional{, maxsplit}}
Return a copy of string \var{str} with all occurrences of substring Return a copy of string \var{str} with all occurrences of substring
\var{old} replaced by \var{new}. \var{old} replaced by \var{new}. If the optional argument
\end{funcdesc} \var{maxsplit} is given, the first \var{maxsplit} occurrences are
replaced.
\begin{funcdesc}{replace1}{old, new, str\optional{, start\optional{, end}}}
Return a copy of string \var{str} with the first occurrence of
substring \var{old} replaced by \var{new}. If no occurrence is found,
\var{str} is returned unchanged. Optional arguments \var{start} and
\var{end} limit the search for \var{old} like for \code{find} (they
are not used to slice the result).
\end{funcdesc} \end{funcdesc}
This module is implemented in Python. Much of its functionality has This module is implemented in Python. Much of its functionality has