Mark the references to module names use \module or \refmodule (the

closing paragraph used \code).
This commit is contained in:
Fred Drake 1999-04-21 16:29:18 +00:00
parent 6ed122a334
commit 8307e21a2a

View file

@ -1,13 +1,11 @@
\section{\module{cmath} --- \section{\module{cmath} ---
Mathematical functions for complex numbers.} Mathematical functions for complex numbers}
\declaremodule{builtin}{cmath} \declaremodule{builtin}{cmath}
\modulesynopsis{Mathematical functions for complex numbers.} \modulesynopsis{Mathematical functions for complex numbers.}
This module is always available. This module is always available. It provides access to mathematical
It provides access to mathematical functions for complex numbers. functions for complex numbers. The functions are:
The functions are:
\begin{funcdesc}{acos}{x} \begin{funcdesc}{acos}{x}
Return the arc cosine of \var{x}. Return the arc cosine of \var{x}.
@ -84,10 +82,10 @@ The mathematical constant \emph{e}, as a real.
\end{datadesc} \end{datadesc}
Note that the selection of functions is similar, but not identical, to Note that the selection of functions is similar, but not identical, to
that in module \code{math}\refbimodindex{math}. The reason for having that in module \refmodule{math}\refbimodindex{math}. The reason for having
two modules is, that some users aren't interested in complex numbers, two modules is, that some users aren't interested in complex numbers,
and perhaps don't even know what they are. They would rather have and perhaps don't even know what they are. They would rather have
\code{math.sqrt(-1)} raise an exception than return a complex number. \code{math.sqrt(-1)} raise an exception than return a complex number.
Also note that the functions defined in \code{cmath} always return a Also note that the functions defined in \module{cmath} always return a
complex number, even if the answer can be expressed as a real number complex number, even if the answer can be expressed as a real number
(in which case the complex number has an imaginary part of zero). (in which case the complex number has an imaginary part of zero).