diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/lib/libanydbm.tex | 8 | ||||
| -rw-r--r-- | Doc/lib/libbinhex.tex | 7 | ||||
| -rw-r--r-- | Doc/lib/libbisect.tex | 5 | ||||
| -rw-r--r-- | Doc/lib/libdbm.tex | 16 | ||||
| -rw-r--r-- | Doc/lib/libgdbm.tex | 56 | ||||
| -rw-r--r-- | Doc/lib/libgzip.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libkeyword.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libselect.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libsite.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libsymbol.tex | 5 | ||||
| -rw-r--r-- | Doc/lib/libtermios.tex | 7 | ||||
| -rw-r--r-- | Doc/lib/libtoken.tex | 5 | ||||
| -rw-r--r-- | Doc/lib/libuser.tex | 5 | ||||
| -rw-r--r-- | Doc/lib/libwhichdb.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libzlib.tex | 4 |
15 files changed, 72 insertions, 66 deletions
diff --git a/Doc/lib/libanydbm.tex b/Doc/lib/libanydbm.tex index 11f5783..5e91941 100644 --- a/Doc/lib/libanydbm.tex +++ b/Doc/lib/libanydbm.tex @@ -1,7 +1,7 @@ \section{\module{anydbm} --- - Generic interface to DBM-style database modules.} -\declaremodule{standard}{anydbm} + Generic access to DBM-style databases} +\declaremodule{standard}{anydbm} \modulesynopsis{Generic interface to DBM-style database modules.} @@ -48,9 +48,9 @@ strings. \section{\module{dumbdbm} --- - Portable implementation of the simple DBM interface.} -\declaremodule{standard}{dumbdbm} + Portable DBM implementation} +\declaremodule{standard}{dumbdbm} \modulesynopsis{Portable implementation of the simple DBM interface.} diff --git a/Doc/lib/libbinhex.tex b/Doc/lib/libbinhex.tex index 1829b40..a3e5f9a 100644 --- a/Doc/lib/libbinhex.tex +++ b/Doc/lib/libbinhex.tex @@ -1,7 +1,7 @@ \section{\module{binhex} --- - Encode and decode files in binhex4 format.} -\declaremodule{standard}{binhex} + Encode and decode binhex4 files} +\declaremodule{standard}{binhex} \modulesynopsis{Encode and decode files in binhex4 format.} @@ -27,7 +27,8 @@ argument is empty in which case the output filename is read from the binhex file. \end{funcdesc} -\subsection{Notes} +\subsection{Notes \label{binhex-notes}} + There is an alternative, more powerful interface to the coder and decoder, see the source for details. diff --git a/Doc/lib/libbisect.tex b/Doc/lib/libbisect.tex index e36cf0e..2b3f117 100644 --- a/Doc/lib/libbisect.tex +++ b/Doc/lib/libbisect.tex @@ -3,13 +3,12 @@ % <arw@pythonpros.com>. \section{\module{bisect} --- - Array bisection algorithms for binary searching.} -\declaremodule{standard}{bisect} + Array bisection algorithm} +\declaremodule{standard}{bisect} \modulesynopsis{Array bisection algorithms for binary searching.} - This module provides support for maintaining a list in sorted order without having to sort the list after each insertion. For long lists of items with expensive comparison operations, this can be an diff --git a/Doc/lib/libdbm.tex b/Doc/lib/libdbm.tex index 2efa6e0..8f64728 100644 --- a/Doc/lib/libdbm.tex +++ b/Doc/lib/libdbm.tex @@ -1,25 +1,25 @@ \section{\module{dbm} --- - The standard ``database'' interface, based on ndbm.} -\declaremodule{builtin}{dbm} + Simple ``database'' interface} +\declaremodule{builtin}{dbm} \modulesynopsis{The standard ``database'' interface, based on ndbm.} -The \code{dbm} module provides an interface to the \UNIX{} +The \module{dbm} module provides an interface to the \UNIX{} \code{(n)dbm} library. Dbm objects behave like mappings (dictionaries), except that keys and values are always strings. Printing a dbm object doesn't print the keys and values, and the \code{items()} and \code{values()} methods are not supported. -See also the \code{gdbm} module, which provides a similar interface -using the GNU GDBM library. -\refbimodindex{gdbm} +See also the \refmodule{gdbm}\refbimodindex{gdbm} module, which +provides a similar interface using the GNU GDBM library. The module defines the following constant and functions: \begin{excdesc}{error} -Raised on dbm-specific errors, such as I/O errors. \code{KeyError} is -raised for general mapping errors like specifying an incorrect key. +Raised on dbm-specific errors, such as I/O errors. +\exception{KeyError} is raised for general mapping errors like +specifying an incorrect key. \end{excdesc} \begin{funcdesc}{open}{filename, \optional{flag, \optional{mode}}} diff --git a/Doc/lib/libgdbm.tex b/Doc/lib/libgdbm.tex index adb1304..e787454 100644 --- a/Doc/lib/libgdbm.tex +++ b/Doc/lib/libgdbm.tex @@ -1,7 +1,7 @@ \section{\module{gdbm} --- - GNU's reinterpretation of dbm.} -\declaremodule{builtin}{gdbm} + GNU's reinterpretation of dbm} +\declaremodule{builtin}{gdbm} \modulesynopsis{GNU's reinterpretation of dbm.} @@ -19,22 +19,23 @@ % this; it's just a little annoying. The warning can be ignored, but % the index produced uses the non-bold version. -This module is quite similar to the \code{dbm} module, but uses \code{gdbm} -instead to provide some additional functionality. Please note that -the file formats created by \code{gdbm} and \code{dbm} are incompatible. -\refbimodindex{dbm} +This module is quite similar to the \module{dbm}\refbimodindex{dbm} +module, but uses \code{gdbm} instead to provide some additional +functionality. Please note that the file formats created by +\code{gdbm} and \code{dbm} are incompatible. -The \code{gdbm} module provides an interface to the GNU DBM +The \module{gdbm} module provides an interface to the GNU DBM library. \code{gdbm} objects behave like mappings (dictionaries), except that keys and values are always strings. -Printing a \code{gdbm} object doesn't print the keys and values, and the -\code{items()} and \code{values()} methods are not supported. +Printing a \code{gdbm} object doesn't print the keys and values, and +the \method{items()} and \method{values()} methods are not supported. The module defines the following constant and functions: \begin{excdesc}{error} -Raised on \code{gdbm}-specific errors, such as I/O errors. \code{KeyError} is -raised for general mapping errors like specifying an incorrect key. +Raised on \code{gdbm}-specific errors, such as I/O errors. +\exception{KeyError} is raised for general mapping errors like +specifying an incorrect key. \end{excdesc} \begin{funcdesc}{open}{filename, \optional{flag, \optional{mode}}} @@ -47,11 +48,11 @@ The optional \var{flag} argument can be \code{'c'} (which creates the database if it doesn't exist), or \code{'n'} (which always creates a new empty database). -Appending \code{f} to the flag opens the database in fast mode; +Appending \character{f} to the flag opens the database in fast mode; altered data will not automatically be written to the disk after every change. This results in faster writes to the database, but may result in an inconsistent database if the program crashes while the database -is still open. Use the \code{sync()} method to force any unwritten +is still open. Use the \method{sync()} method to force any unwritten data to be written to the disk. The optional \var{mode} argument is the \UNIX{} mode of the file, used @@ -63,34 +64,35 @@ In addition to the dictionary-like methods, \code{gdbm} objects have the following methods: \begin{funcdesc}{firstkey}{} -It's possible to loop over every key in the database using this method -and the \code{nextkey()} method. The traversal is ordered by \code{gdbm}'s -internal hash values, and won't be sorted by the key values. This -method returns the starting key. +It's possible to loop over every key in the database using this method +and the \method{nextkey()} method. The traversal is ordered by +\code{gdbm}'s internal hash values, and won't be sorted by the key +values. This method returns the starting key. \end{funcdesc} \begin{funcdesc}{nextkey}{key} Returns the key that follows \var{key} in the traversal. The -following code prints every key in the database \code{db}, without having to -create a list in memory that contains them all: +following code prints every key in the database \code{db}, without +having to create a list in memory that contains them all: + \begin{verbatim} -k=db.firstkey() -while k!=None: +k = db.firstkey() +while k != None: print k - k=db.nextkey(k) + k = db.nextkey(k) \end{verbatim} \end{funcdesc} \begin{funcdesc}{reorganize}{} If you have carried out a lot of deletions and would like to shrink -the space used by the \code{gdbm} file, this routine will reorganize the -database. \code{gdbm} will not shorten the length of a database file except -by using this reorganization; otherwise, deleted file space will be -kept and reused as new (key,value) pairs are added. +the space used by the \code{gdbm} file, this routine will reorganize +the database. \code{gdbm} will not shorten the length of a database +file except by using this reorganization; otherwise, deleted file +space will be kept and reused as new (key, value) pairs are added. \end{funcdesc} \begin{funcdesc}{sync}{} -When the database has been opened in fast mode, this method forces any +When the database has been opened in fast mode, this method forces any unwritten data to be written to the disk. \end{funcdesc} diff --git a/Doc/lib/libgzip.tex b/Doc/lib/libgzip.tex index 3bae734..ba3267c 100644 --- a/Doc/lib/libgzip.tex +++ b/Doc/lib/libgzip.tex @@ -1,7 +1,7 @@ \section{\module{gzip} --- - \program{gzip} compression and decompression using files.} -\declaremodule{standard}{gzip} + Support for \program{gzip} files} +\declaremodule{standard}{gzip} \modulesynopsis{Interfaces for \program{gzip} compression and decompression using file objects.} diff --git a/Doc/lib/libkeyword.tex b/Doc/lib/libkeyword.tex index 16cff84..9e6761b 100644 --- a/Doc/lib/libkeyword.tex +++ b/Doc/lib/libkeyword.tex @@ -1,7 +1,7 @@ \section{\module{keyword} --- - Test whether a string is a Python keyword.} -\declaremodule{standard}{keyword} + Testing for Python keywords} +\declaremodule{standard}{keyword} \modulesynopsis{Test whether a string is a keyword in Python.} diff --git a/Doc/lib/libselect.tex b/Doc/lib/libselect.tex index 888914e..de5e1a6 100644 --- a/Doc/lib/libselect.tex +++ b/Doc/lib/libselect.tex @@ -1,7 +1,7 @@ \section{\module{select} --- - Wait for I/O completion on multiple streams.} -\declaremodule{builtin}{select} + Waiting for I/O completion} +\declaremodule{builtin}{select} \modulesynopsis{Wait for I/O completion on multiple streams.} diff --git a/Doc/lib/libsite.tex b/Doc/lib/libsite.tex index e8bafd6..e0afe30 100644 --- a/Doc/lib/libsite.tex +++ b/Doc/lib/libsite.tex @@ -1,7 +1,7 @@ \section{\module{site} --- - A standard way to reference site-specific modules.} -\declaremodule{standard}{site} + Site-specific configuration hook} +\declaremodule{standard}{site} \modulesynopsis{A standard way to reference site-specific modules.} diff --git a/Doc/lib/libsymbol.tex b/Doc/lib/libsymbol.tex index 7d9f9ac..9b27277 100644 --- a/Doc/lib/libsymbol.tex +++ b/Doc/lib/libsymbol.tex @@ -1,8 +1,9 @@ \section{\module{symbol} --- - Constants representing internal nodes of the parse tree.} -\declaremodule{standard}{symbol} + Constants used with Python parse trees} +\declaremodule{standard}{symbol} \modulesynopsis{Constants representing internal nodes of the parse tree.} +\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} This module provides constants which represent the numeric values of diff --git a/Doc/lib/libtermios.tex b/Doc/lib/libtermios.tex index 9c9c3c8..9482203 100644 --- a/Doc/lib/libtermios.tex +++ b/Doc/lib/libtermios.tex @@ -95,17 +95,18 @@ def getpass(prompt = "Password: "): return passwd \end{verbatim} + \section{\module{TERMIOS} --- - Constants used with the \module{termios} module.} -\declaremodule[TERMIOSuppercase]{standard}{TERMIOS} + Constants used with \module{termios}} +\declaremodule[TERMIOSuppercase]{standard}{TERMIOS} \modulesynopsis{Symbolic constants required to use the \module{termios} module.} + \indexii{\POSIX{}}{I/O control} \indexii{tty}{I/O control} - This module defines the symbolic constants required to use the \module{termios}\refbimodindex{termios} module (see the previous section). See the \POSIX{} or \UNIX{} manual pages (or the source) diff --git a/Doc/lib/libtoken.tex b/Doc/lib/libtoken.tex index 87477c5..4215106 100644 --- a/Doc/lib/libtoken.tex +++ b/Doc/lib/libtoken.tex @@ -1,8 +1,9 @@ \section{\module{token} --- - Constants representing terminal nodes of the parse tree.} -\declaremodule{standard}{token} + Constants used with Python parse trees} +\declaremodule{standard}{token} \modulesynopsis{Constants representing terminal nodes of the parse tree.} +\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} This module provides constants which represent the numeric values of diff --git a/Doc/lib/libuser.tex b/Doc/lib/libuser.tex index 9e9c6ed..cd460ea 100644 --- a/Doc/lib/libuser.tex +++ b/Doc/lib/libuser.tex @@ -1,9 +1,10 @@ \section{\module{user} --- - A standard way to reference user-specific modules.} -\declaremodule{standard}{user} + User-specific configuration hook} +\declaremodule{standard}{user} \modulesynopsis{A standard way to reference user-specific modules.} + \indexii{.pythonrc.py}{file} \indexiii{user}{configuration}{file} diff --git a/Doc/lib/libwhichdb.tex b/Doc/lib/libwhichdb.tex index b3035cf..06b9934 100644 --- a/Doc/lib/libwhichdb.tex +++ b/Doc/lib/libwhichdb.tex @@ -1,7 +1,7 @@ \section{\module{whichdb} --- - Guess which DBM-style module created a given database.} -\declaremodule{standard}{whichdb} + Guess which DBM module created a database} +\declaremodule{standard}{whichdb} \modulesynopsis{Guess which DBM-style module created a given database.} diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index aaf4684..bdee0a0 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -2,9 +2,9 @@ % hasn't been updated completely. \section{\module{zlib} --- - Compression and decompression compatible with \program{gzip}.} -\declaremodule{builtin}{zlib} + Compression library compatible with \program{gzip}.} +\declaremodule{builtin}{zlib} \modulesynopsis{Low-level interface to compression and decompression routines compatible with \program{gzip}.} |