Make all the \seemodule explanations consistent: start with a capitalized
letter and end with proper punctuation. "Documenting Python" will be updated accordingly so that this will be editorial policy for the Python documentation.
This commit is contained in:
parent
510dfbad3d
commit
ba0a989988
|
@ -185,8 +185,10 @@ array('d', [1.0, 2.0, 3.14])
|
|||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{struct}{packing and unpacking of heterogeneous binary data}
|
||||
\seemodule{xdrlib}{packing and unpacking of XDR data}
|
||||
\seemodule{struct}{Packing and unpacking of heterogeneous binary data.}
|
||||
\seemodule{xdrlib}{Packing and unpacking of External Data
|
||||
Representation (XDR) data as used in some remote
|
||||
procedure call systems.}
|
||||
\seetitle[http://numpy.sourceforge.net/numdoc/numdoc.pdf]{The
|
||||
Numerical Python Manual}{The Numeric Python extension
|
||||
(NumPy) defines another array type; see
|
||||
|
|
|
@ -50,8 +50,8 @@ base64 encoded data.
|
|||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{binascii}{support module containing \ASCII{}-to-binary
|
||||
and binary-to-\ASCII{} conversions}
|
||||
\seemodule{binascii}{Support module containing \ASCII{}-to-binary
|
||||
and binary-to-\ASCII{} conversions.}
|
||||
\seetext{Internet \rfc{1521}, \emph{MIME (Multipurpose Internet
|
||||
Mail Extensions) Part One: Mechanisms for Specifying and
|
||||
Describing the Format of Internet Message Bodies}, section
|
||||
|
|
|
@ -29,8 +29,8 @@ binhex file.
|
|||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{binascii}{support module containing \ASCII{}-to-binary
|
||||
and binary-to-\ASCII{} conversions}
|
||||
\seemodule{binascii}{Support module containing \ASCII-to-binary
|
||||
and binary-to-\ASCII{} conversions.}
|
||||
\end{seealso}
|
||||
|
||||
|
||||
|
|
|
@ -65,5 +65,6 @@ argument is required; \var{mode} defaults to \code{'rb'} and
|
|||
\end{funcdesc}
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{zlib}{the basic data compression module}
|
||||
\seemodule{zlib}{The basic data compression module needed to support
|
||||
the \program{gzip} file format.}
|
||||
\end{seealso}
|
||||
|
|
|
@ -26,6 +26,6 @@ can be an arbitrary integer.
|
|||
\end{funcdesc}
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{whrandom}{the standard Python random number generator}
|
||||
\seemodule{random}{Python's interface to random number generators.}
|
||||
\seemodule{whrandom}{The random number generator used by default.}
|
||||
\end{seealso}
|
||||
|
||||
|
|
|
@ -16,13 +16,15 @@ to may change between Python versions.
|
|||
This module also provides one additional data object:
|
||||
|
||||
|
||||
|
||||
\begin{datadesc}{sym_name}
|
||||
Dictionary mapping the numeric values of the constants defined in this
|
||||
module back to name strings, allowing more human-readable
|
||||
representation of parse trees to be generated.
|
||||
Dictionary mapping the numeric values of the constants defined in
|
||||
this module back to name strings, allowing more human-readable
|
||||
representation of parse trees to be generated.
|
||||
\end{datadesc}
|
||||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{parser}{second example uses this module}
|
||||
\seemodule{parser}{The second example for the \refmodule{parser}
|
||||
module shows how to use the \module{symbol}
|
||||
module.}
|
||||
\end{seealso}
|
||||
|
|
|
@ -36,6 +36,9 @@ Return true for non-terminal token values.
|
|||
Return true if \var{x} is the marker indicating the end of input.
|
||||
\end{funcdesc}
|
||||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{parser}{second example uses this module}
|
||||
\seemodule{parser}{The second example for the \refmodule{parser}
|
||||
module shows how to use the \module{symbol}
|
||||
module.}
|
||||
\end{seealso}
|
||||
|
|
|
@ -65,6 +65,5 @@ Modules for general use should \emph{not} import this module; it may
|
|||
interfere with the operation of the importing program.
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{site}{site-wide customization mechanism}
|
||||
\refstmodindex{site}
|
||||
\seemodule{site}{Site-wide customization mechanism.}
|
||||
\end{seealso}
|
||||
|
|
|
@ -39,6 +39,6 @@ for \var{out_file} and \var{mode} are taken from the uuencode header.
|
|||
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{binascii}{support module containing \ASCII{}-to-binary
|
||||
and binary-to-\ASCII{} conversions}
|
||||
\seemodule{binascii}{Support module containing \ASCII-to-binary
|
||||
and binary-to-\ASCII{} conversions.}
|
||||
\end{seealso}
|
||||
|
|
|
@ -148,7 +148,7 @@ action is to delete the object.
|
|||
\end{methoddesc}
|
||||
|
||||
\begin{seealso}
|
||||
\seemodule{gzip}{reading and writing \program{gzip}-format files}
|
||||
\seemodule{gzip}{Reading and writing \program{gzip}-format files.}
|
||||
\seeurl{http://www.info-zip.org/pub/infozip/zlib/}{The
|
||||
zlib library home page.}
|
||||
\end{seealso}
|
||||
|
|
Loading…
Reference in New Issue