]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Make all the \seemodule explanations consistent: start with a capitalized
authorFred Drake <fdrake@acm.org>
Wed, 18 Oct 2000 17:43:06 +0000 (17:43 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 18 Oct 2000 17:43:06 +0000 (17:43 +0000)
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
Doc/lib/libbase64.tex
Doc/lib/libbinhex.tex
Doc/lib/libgzip.tex
Doc/lib/librand.tex
Doc/lib/libsymbol.tex
Doc/lib/libtoken.tex
Doc/lib/libuser.tex
Doc/lib/libuu.tex
Doc/lib/libzlib.tex

index d6f5b5c3103d75c202dcb3eda0849abb760b5572..1574b1f502e8872059f2b6275154242b7a0f3feb 100644 (file)
@@ -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
index bede70886febc4f4c82b39957b02852ab3ee83cb..b608a8a0c9bf76dda66b28f4003b4d3c4afbc653 100644 (file)
@@ -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
index e181798389c9c9f7159c39504a900252dfd8e282..4afc3629fba75f504d6781d002e9e940b42c982b 100644 (file)
@@ -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}
 
 
index 3df75ce8bd535b872add7082a7dbcfc289d4d336..34ec897ac7c724967c1e5d403bb4438364a233e0 100644 (file)
@@ -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}
index e33571847935761dca1abd10aff1d7c50cb80dff..9b2c685b03454e7ba5d24dab108e3bf395b510d6 100644 (file)
@@ -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}
-
index f963b5363ba6023d23fdd3d7ce4a1109bc30348f..54cabeb7bc9a6fd1500d6e46a576a7ecc0705bcb 100644 (file)
@@ -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}
index a15a78c43e728997ca174729ccc22186e794a5a3..47f4750db3cf23ee73558cce7926769d0f55c9a2 100644 (file)
@@ -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}
index 4a79a54793cb4f0d63c182120c09bd5929f1c7c5..b2735bbf84faccdca63aae7c64eef8d7819a3895 100644 (file)
@@ -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}
index b6dc318e36045ffc5ca0354f09ee0aeb59f16afd..ea4a9e49f5c39f5124dae96713a01b333d4f3ea8 100644 (file)
@@ -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}
index 0b3dd09e3d3508fb3071d661d2a8f7a72148d0b4..1da7f783523101f2509d43d2a38e20e32fcb4314 100644 (file)
@@ -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}