Add note about platform-specific behavior arising from discussion on bug

711019.
This commit is contained in:
Skip Montanaro 2003-04-26 02:59:00 +00:00
parent 8b7beb631b
commit 5118341530
1 changed files with 11 additions and 1 deletions

View File

@ -17,7 +17,7 @@ complex result allows earlier detection of the unexpected complex
number used as a parameter, so that the programmer can determine how number used as a parameter, so that the programmer can determine how
and why it was generated in the first place. and why it was generated in the first place.
The following functions provided by this module: The following functions are provided by this module:
\begin{funcdesc}{acos}{x} \begin{funcdesc}{acos}{x}
Return the arc cosine of \var{x}. Return the arc cosine of \var{x}.
@ -145,6 +145,16 @@ The mathematical constant \emph{pi}.
The mathematical constant \emph{e}. The mathematical constant \emph{e}.
\end{datadesc} \end{datadesc}
\begin{notice}
Specific exceptions raised in assorted error cases (and even whether some
arguments are considered to be exceptional at all) are not defined in any
useful cross-platform or cross-release way. For example, whether
\code{math.log(0)} returns \code{-Inf} or raises \exception{ValueError} or
\exception{OverflowError} is both platform- and release-dependent, and in
cases where \code{math.log(0)} raises an \exception{OverflowError},
\code{math.log(0L)} often raises a \exception{ValueError}.
\end{notice}
\begin{seealso} \begin{seealso}
\seemodule{cmath}{Complex number versions of many of these functions.} \seemodule{cmath}{Complex number versions of many of these functions.}
\end{seealso} \end{seealso}