[Python-checkins] CVS: python/dist/src/Doc/lib libundoc.tex,1.75,1.76
Fred L. Drake
python-dev@python.org
Sun, 10 Sep 2000 22:23:28 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv24311/lib
Modified Files:
libundoc.tex
Log Message:
Some updates and fix a bunch of really small consistency nits.
Index: libundoc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libundoc.tex,v
retrieving revision 1.75
retrieving revision 1.76
diff -C2 -r1.75 -r1.76
*** libundoc.tex 2000/07/16 19:01:10 1.75
--- libundoc.tex 2000/09/11 05:23:25 1.76
***************
*** 1,11 ****
! \chapter{Undocumented Modules}
! \label{undoc}
Here's a quick listing of modules that are currently undocumented, but
that should be documented. Feel free to contribute documentation for
! them! (The idea and original contents for this chapter were taken
! from a posting by Fredrik Lundh; I have revised some modules' status.)
\section{Frameworks}
--- 1,13 ----
! \chapter{Undocumented Modules \label{undoc}}
Here's a quick listing of modules that are currently undocumented, but
that should be documented. Feel free to contribute documentation for
! them! (Send via email to \email{python-docs@python.org}.)
+ The idea and original contents for this chapter were taken
+ from a posting by Fredrik Lundh; the specific contents of this chapter
+ have been substantially revised.
+
\section{Frameworks}
***************
*** 30,34 ****
--- Regression testing framework. This is used for the Python
regression test, but is useful for other Python libraries as well.
! This is a package rather than a module.
\end{description}
--- 32,36 ----
--- Regression testing framework. This is used for the Python
regression test, but is useful for other Python libraries as well.
! This is a package rather than a single module.
\end{description}
***************
*** 39,56 ****
\begin{description}
- \item[\module{dircmp}]
- --- Class to build directory diff tools on (may become a demo or tool).
- \deprecated{2.0}{The \refmodule{filecmp} module will replace
- \module{dircmp}.}
-
\item[\module{bdb}]
! --- A generic Python debugger base class (used by pdb)
\item[\module{ihooks}]
! --- Import hook support (for \refmodule{rexec}; may become obsolete)
\item[\module{tzparse}]
--- Parse a timezone specification (unfinished; may disappear in the
! future)
\end{description}
--- 41,53 ----
\begin{description}
\item[\module{bdb}]
! --- A generic Python debugger base class (used by pdb).
\item[\module{ihooks}]
! --- Import hook support (for \refmodule{rexec}; may become obsolete).
\item[\module{tzparse}]
--- Parse a timezone specification (unfinished; may disappear in the
! future).
\end{description}
***************
*** 64,74 ****
\begin{description}
\item[\module{dospath}]
! --- implementation of \module{os.path} on MS-DOS
\item[\module{ntpath}]
! --- implementation on \module{os.path} on 32-bit Windows
\item[\module{posixpath}]
! --- implementation on \module{os.path} on \POSIX{}
\end{description}
--- 61,72 ----
\begin{description}
\item[\module{dospath}]
! --- Implementation of \module{os.path} on MS-DOS.
\item[\module{ntpath}]
! --- Implementation on \module{os.path} on Win32, Win64, WinCE, and
! OS/2 platforms.
\item[\module{posixpath}]
! --- Implementation on \module{os.path} on \POSIX.
\end{description}
***************
*** 78,85 ****
\begin{description}
\item[\module{audiodev}]
! --- Platform-independent API for playing audio data
\item[\module{sunaudio}]
! --- Interpret Sun audio headers (may become obsolete or a tool/demo)
\item[\module{toaiff}]
--- 76,83 ----
\begin{description}
\item[\module{audiodev}]
! --- Platform-independent API for playing audio data.
\item[\module{sunaudio}]
! --- Interpret Sun audio headers (may become obsolete or a tool/demo).
\item[\module{toaiff}]
***************
*** 109,113 ****
\begin{description}
\item[\module{addpack}]
! --- alternate approach to packages
\item[\module{cmp}]
--- 107,112 ----
\begin{description}
\item[\module{addpack}]
! --- Alternate approach to packages. Use the built-in package support
! instead.
\item[\module{cmp}]
***************
*** 125,153 ****
\item[\module{dircmp}]
! --- class to build directory diff tools on (may become a demo or tool)
\item[\module{dump}]
! --- Print python code that reconstructs a variable
\item[\module{fmt}]
! --- text formatting abstractions (too slow)
\item[\module{lockfile}]
! --- wrapper around FCNTL file locking (use
! \function{fcntl.lockf()}/\function{flock()} instead; see \refmodule{fcntl})
\item[\module{newdir}]
--- New \function{dir()} function (the standard \function{dir()} is
! now just as good)
\item[\module{Para}]
! --- helper for fmt.py
\item[\module{poly}]
! --- Polynomials
\item[\module{tb}]
--- Print tracebacks, with a dump of local variables (use
! \function{pdb.pm()} or \refmodule{traceback} instead)
\item[\module{timing}]
--- 124,154 ----
\item[\module{dircmp}]
! --- Class to build directory diff tools on (may become a demo or tool).
! \deprecated{2.0}{The \refmodule{filecmp} module replaces
! \module{dircmp}.}
\item[\module{dump}]
! --- Print python code that reconstructs a variable.
\item[\module{fmt}]
! --- Text formatting abstractions (too slow).
\item[\module{lockfile}]
! --- Wrapper around FCNTL file locking (use
! \function{fcntl.lockf()}/\function{flock()} instead; see \refmodule{fcntl}).
\item[\module{newdir}]
--- New \function{dir()} function (the standard \function{dir()} is
! now just as good).
\item[\module{Para}]
! --- Helper for \module{fmt}.
\item[\module{poly}]
! --- Polynomials.
\item[\module{tb}]
--- Print tracebacks, with a dump of local variables (use
! \function{pdb.pm()} or \refmodule{traceback} instead).
\item[\module{timing}]
***************
*** 158,169 ****
--- Useful functions that don't fit elsewhere.
- \item[\module{wdb}]
- --- A primitive windowing debugger based on STDWIN.
-
\item[\module{whatsound}]
--- Recognize sound files; use \refmodule{sndhdr} instead.
\item[\module{zmod}]
! --- Compute properties of mathematical "fields"
\end{description}
--- 159,167 ----
--- Useful functions that don't fit elsewhere.
\item[\module{whatsound}]
--- Recognize sound files; use \refmodule{sndhdr} instead.
\item[\module{zmod}]
! --- Compute properties of mathematical ``fields.''
\end{description}
***************
*** 174,184 ****
\begin{description}
\item[\module{find}]
! --- find files matching pattern in directory tree
\item[\module{grep}]
! --- grep
\item[\module{packmail}]
! --- create a self-unpacking \UNIX{} shell archive
\end{description}
--- 172,182 ----
\begin{description}
\item[\module{find}]
! --- Find files matching pattern in directory tree.
\item[\module{grep}]
! --- \program{grep} implementation in Python.
\item[\module{packmail}]
! --- Create a self-unpacking \UNIX{} shell archive.
\end{description}
***************
*** 192,196 ****
\item[\module{ni}]
--- Import modules in ``packages.'' Basic package support is now
! built in.
\item[\module{rand}]
--- 190,195 ----
\item[\module{ni}]
--- Import modules in ``packages.'' Basic package support is now
! built in. The built-in support is very similar to what is provided in
! this module.
\item[\module{rand}]
***************
*** 199,214 ****
\item[\module{soundex}]
--- Algorithm for collapsing names which sound similar to a shared
! key. (This is an extension module.)
\end{description}
-
- \section{Extension modules}
! \begin{description}
! \item[\module{stdwin}]
! --- Interface to STDWIN (an old, unsupported
! platform-independent GUI package). Obsolete; use \module{Tkinter} for
! a platform-independent GUI instead.
! \end{description}
The following are SGI specific, and may be out of touch with the
--- 198,207 ----
\item[\module{soundex}]
--- Algorithm for collapsing names which sound similar to a shared
! key. The specific algorithm doesn't seem to match any published
! algorithm. (This is an extension module.)
\end{description}
! \section{SGI-specific Extension modules}
The following are SGI specific, and may be out of touch with the