]> granicus.if.org Git - python/commitdiff
Fixed lots of small nits caught by Ka-Ping Yee <ping@lfw.org>.
authorFred Drake <fdrake@acm.org>
Tue, 10 Oct 2000 17:03:45 +0000 (17:03 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 10 Oct 2000 17:03:45 +0000 (17:03 +0000)
16 files changed:
Doc/lib/libcmd.tex
Doc/lib/libcurses.tex
Doc/lib/libdis.tex
Doc/lib/liberrno.tex
Doc/lib/libgetopt.tex
Doc/lib/libimghdr.tex
Doc/lib/libnew.tex
Doc/lib/libpprint.tex
Doc/lib/libqueue.tex
Doc/lib/libreadline.tex
Doc/lib/librepr.tex
Doc/lib/librlcompleter.tex
Doc/lib/librotor.tex
Doc/lib/libsignal.tex
Doc/lib/libsndhdr.tex
Doc/lib/libsocksvr.tex

index 83e5ff8549f6111b985a30e078575dc42306afab..37e08a2933f0d8ad26ffbf2ad87eb75c57df42c5 100644 (file)
@@ -1,10 +1,9 @@
 \section{\module{cmd} ---
-         Build line-oriented command interpreters.}
+         Support for line-oriented command interpreters}
+
 \declaremodule{standard}{cmd}
 \sectionauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
-
-\modulesynopsis{Build line-oriented command interpreters; this is used
-by module \module{pdb}.}
+\modulesynopsis{Build line-oriented command interpreters.}
 
 
 The \class{Cmd} class provides a simple framework for writing
index e3e94ad1fda53e690c5df306ee1600f6afe245a7..d5a8c2b7aa2d9b616bc7c8df163f0ff95ad9aaf0 100644 (file)
@@ -1,10 +1,11 @@
 \section{\module{curses} ---
-         Screen painting and input handling for character-cell terminals}
+         Terminal handling for character-cell displays}
 
 \declaremodule{standard}{curses}
 \sectionauthor{Moshe Zadka}{mzadka@geocities.com}
 \sectionauthor{Eric Raymond}{esr@thyrsus.com}
-\modulesynopsis{An interface to the curses library.}
+\modulesynopsis{An interface to the curses library, providing portable
+                terminal handling.}
 
 \versionchanged[Added support for the \code{ncurses} library and
                 converted to a package]{1.6}
index f31c9f47f65f601f38478370ce51d85a83f0db21..2dd74bdb6200026c86bd3953b715a498ec6eb8bf 100644 (file)
@@ -1,8 +1,9 @@
 \section{\module{dis} ---
-         Disassembler.}
-\declaremodule{standard}{dis}
+         Disassembler for Python byte code}
 
-\modulesynopsis{Disassembler.}
+\declaremodule{standard}{dis}
+\modulesynopsis{Disassembler for Python byte code, as stored in code
+                objects and \file{.pyc}/\file{.pyo} files.}
 
 
 The \module{dis} module supports the analysis of Python byte code by
index 7e0c1a9b59010b288243b616564f9cd53e9d3464..c0ce6e8b38422844f2babb49ae4f9094bce0ffa4 100644 (file)
@@ -1,12 +1,11 @@
 \section{\module{errno} ---
-         Standard errno system symbols.}
-\declaremodule{standard}{errno}
+         Standard errno system symbols}
 
+\declaremodule{standard}{errno}
 \modulesynopsis{Standard errno system symbols.}
 
 
-
-This module makes available standard errno system symbols.
+This module makes available standard \code{errno} system symbols.
 The value of each symbol is the corresponding integer value.
 The names and descriptions are borrowed from \file{linux/include/errno.h},
 which should be pretty all-inclusive.
@@ -21,8 +20,9 @@ To translate a numeric error code to an error message, use
 \function{os.strerror()}.
 
 Of the following list, symbols that are not used on the current
-platform are not defined by the module.  Symbols available can
-include:
+platform are not defined by the module.  The specific list of defined
+symbols is available as \code{errno.errorcode.keys()}.  Symbols
+available can include:
 
 \begin{datadesc}{EPERM} Operation not permitted \end{datadesc}
 \begin{datadesc}{ENOENT} No such file or directory \end{datadesc}
index 4f32225f3fc9b810eeed58dfaddfb88015a3faf2..6731c3220a26f45297bbf01a121daf0aa572c4ec 100644 (file)
@@ -1,8 +1,9 @@
 \section{\module{getopt} ---
-         Parser for command line options.}
-\declaremodule{standard}{getopt}
+         Parser for command line options}
 
-\modulesynopsis{Parser for command line options.}
+\declaremodule{standard}{getopt}
+\modulesynopsis{Portable parser for command line options; support both
+                short and long option names.}
 
 
 This module helps scripts to parse the command line arguments in
index 54e58014876152d34cc6881da0f174524369eb36..2f1ac7d9f0f189ba230b43f8abbae7f963a3f6ec 100644 (file)
@@ -1,8 +1,9 @@
 \section{\module{imghdr} ---
-         Determine the type of an image.}
-\declaremodule{standard}{imghdr}
+         Determine the type of an image}
 
-\modulesynopsis{Determine the type of image contained in a file or byte stream.}
+\declaremodule{standard}{imghdr}
+\modulesynopsis{Determine the type of image contained in a file or
+                byte stream.}
 
 
 The \module{imghdr} module determines the type of image contained in a
index 24fc881af15ccc8406c465373c0aaf652026c2e4..df7adfbd26f868642677ded86ed85550abeab8fb 100644 (file)
@@ -1,5 +1,5 @@
 \section{\module{new} ---
-         Runtime implementation object creation}
+         Creation of runtime internal objects}
 
 \declaremodule{builtin}{new}
 \sectionauthor{Moshe Zadka}{mzadka@geocities.com}
index 82eb19725286941803c2c79eda7a1ff932b2689b..3ecc7bc0377f02ee663264647d65cc5721b5c11d 100644 (file)
@@ -1,5 +1,5 @@
 \section{\module{pprint} ---
-         Data pretty printer.}
+         Data pretty printer}
 
 \declaremodule{standard}{pprint}
 \modulesynopsis{Data pretty printer.}
index 2bb6a2fdd9801317743e94ab455ae1d0186f36e3..0abed61c8383c482ed1ddbcd778e844d189f208a 100644 (file)
@@ -1,11 +1,10 @@
 \section{\module{Queue} ---
-         A synchronized queue class.}
-\declaremodule{standard}{Queue}
+         A synchronized queue class}
 
+\declaremodule{standard}{Queue}
 \modulesynopsis{A synchronized queue class.}
 
 
-
 The \module{Queue} module implements a multi-producer, multi-consumer
 FIFO queue.  It is especially useful in threads programming when
 information must be exchanged safely between multiple threads.  The
index f59ddac8b1ac45c47ab10f03f0930aec658fbece..9d0091ab3f9e79a95cbf6309f38a38b7f3788e5f 100644 (file)
@@ -4,7 +4,7 @@
 \declaremodule{builtin}{readline}
   \platform{Unix}
 \sectionauthor{Skip Montanaro}{skip@mojam.com}
-\modulesynopsis{GNU Readline in Python.}
+\modulesynopsis{GNU readline support for Python.}
 
 
 The \module{readline} module defines a number of functions used either
index 2a372c8c2cba4e828962caa08d85034f5ce8af28..8dfd0b445515ec747771434a03f6e80d00937a5f 100644 (file)
@@ -1,5 +1,5 @@
 \section{\module{repr} ---
-         Alternate \function{repr()} implementation.}
+         Alternate \function{repr()} implementation}
 
 \sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
 \declaremodule{standard}{repr}
index c0c4db858b802cf65c079f028ed42fdd10e7edc3..3ff1cf35c8ac9b8ddbdbc99357417b4b7d07c283 100644 (file)
@@ -1,10 +1,10 @@
 \section{\module{rlcompleter} ---
-         Completion function for readline}
+         Completion function for GNU readline}
 
 \declaremodule{standard}{rlcompleter}
   \platform{Unix}
 \sectionauthor{Moshe Zadka}{mzadka@geocities.com}
-\modulesynopsis{Python identifier completion in the readline library.}
+\modulesynopsis{Python identifier completion for the GNU readline library.}
 
 The \module{rlcompleter} module defines a completion function for
 the \refmodule{readline} module by completing valid Python identifiers
index 799df83a806cb31a26a991e9b3b455192f2027e6..6ed031cfeb30b74fcfb6759d4a20e860aa806330 100644 (file)
@@ -1,7 +1,7 @@
 \section{\module{rotor} ---
-         Enigma-like encryption and decryption.}
-\declaremodule{builtin}{rotor}
+         Enigma-like encryption and decryption}
 
+\declaremodule{builtin}{rotor}
 \modulesynopsis{Enigma-like encryption and decryption.}
 
 
index ce23da16be234d07f819dd6e9017bc6750b2a05c..11f07373fa874596cc43e92f20c36a56046bdd31 100644 (file)
@@ -1,10 +1,10 @@
 \section{\module{signal} ---
-         Set handlers for asynchronous events.}
-\declaremodule{builtin}{signal}
-
+         Set handlers for asynchronous events}
 
+\declaremodule{builtin}{signal}
 \modulesynopsis{Set handlers for asynchronous events.}
 
+
 This module provides mechanisms to use signal handlers in Python.
 Some general rules for working with signals and their handlers:
 
index 43f04ec7cb58bbbaa95dcdafd57b30fb4b39bd6e..a7f8c6eaaea28f75299989598c9913981edc1318 100644 (file)
@@ -1,5 +1,5 @@
 \section{\module{sndhdr} ---
-         Determine type of sound file.}
+         Determine type of sound file}
 
 \declaremodule{standard}{sndhdr}
 \modulesynopsis{Determine type of a sound file.}
index 120b049e97e299f5b09096559fd2877139550a40..18a2fe8f8a575340e7e844c43981eb91ebe5782b 100644 (file)
@@ -1,7 +1,7 @@
 \section{\module{SocketServer} ---
-         A framework for network servers.}
-\declaremodule{standard}{SocketServer}
+         A framework for network servers}
 
+\declaremodule{standard}{SocketServer}
 \modulesynopsis{A framework for network servers.}