From ba0a9899880849f05ab22190147528b0ea054f5a Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Wed, 18 Oct 2000 17:43:06 +0000 Subject: 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. --- Doc/lib/libarray.tex | 6 ++++-- Doc/lib/libbase64.tex | 4 ++-- Doc/lib/libbinhex.tex | 4 ++-- Doc/lib/libgzip.tex | 3 ++- Doc/lib/librand.tex | 4 ++-- Doc/lib/libsymbol.tex | 12 +++++++----- Doc/lib/libtoken.tex | 5 ++++- Doc/lib/libuser.tex | 3 +-- Doc/lib/libuu.tex | 4 ++-- Doc/lib/libzlib.tex | 2 +- 10 files changed, 27 insertions(+), 20 deletions(-) diff --git a/Doc/lib/libarray.tex b/Doc/lib/libarray.tex index d6f5b5c..1574b1f 100644 --- a/Doc/lib/libarray.tex +++ b/Doc/lib/libarray.tex @@ -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 diff --git a/Doc/lib/libbase64.tex b/Doc/lib/libbase64.tex index bede708..b608a8a 100644 --- a/Doc/lib/libbase64.tex +++ b/Doc/lib/libbase64.tex @@ -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 diff --git a/Doc/lib/libbinhex.tex b/Doc/lib/libbinhex.tex index e181798..4afc362 100644 --- a/Doc/lib/libbinhex.tex +++ b/Doc/lib/libbinhex.tex @@ -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} diff --git a/Doc/lib/libgzip.tex b/Doc/lib/libgzip.tex index 3df75ce..34ec897 100644 --- a/Doc/lib/libgzip.tex +++ b/Doc/lib/libgzip.tex @@ -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} diff --git a/Doc/lib/librand.tex b/Doc/lib/librand.tex index e335718..9b2c685 100644 --- a/Doc/lib/librand.tex +++ b/Doc/lib/librand.tex @@ -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} - diff --git a/Doc/lib/libsymbol.tex b/Doc/lib/libsymbol.tex index f963b53..54cabeb 100644 --- a/Doc/lib/libsymbol.tex +++ b/Doc/lib/libsymbol.tex @@ -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} diff --git a/Doc/lib/libtoken.tex b/Doc/lib/libtoken.tex index a15a78c..47f4750 100644 --- a/Doc/lib/libtoken.tex +++ b/Doc/lib/libtoken.tex @@ -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} diff --git a/Doc/lib/libuser.tex b/Doc/lib/libuser.tex index 4a79a54..b2735bb 100644 --- a/Doc/lib/libuser.tex +++ b/Doc/lib/libuser.tex @@ -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} diff --git a/Doc/lib/libuu.tex b/Doc/lib/libuu.tex index b6dc318..ea4a9e4 100644 --- a/Doc/lib/libuu.tex +++ b/Doc/lib/libuu.tex @@ -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} diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index 0b3dd09..1da7f78 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -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} -- cgit v0.12