Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ae4d5c2

Browse files
committed
Various updates.
1 parent 66239d5 commit ae4d5c2

1 file changed

Lines changed: 20 additions & 24 deletions

File tree

Doc/lib/libundoc.tex

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,11 @@ \section{Frameworks}
3131

3232
\section{Miscellaneous useful utilities}
3333

34-
Some of these are very old and/or not very robust; marked with ``hmm''.
34+
Some of these are very old and/or not very robust; marked with ``hmm.''
3535

3636
\begin{description}
3737
\item[dircmp.py]
38-
--- class to build directory diff tools on
39-
40-
\item[pipes.py]
41-
--- Conversion pipeline templates (hmm, used by \module{toaiff} and
42-
\module{torgb})
38+
--- class to build directory diff tools on (may become a demo or tool)
4339

4440
\item[pty.py]
4541
--- Pseudo terminal utilities
@@ -51,7 +47,7 @@ \section{Miscellaneous useful utilities}
5147
--- A generic Python debugger base class (used by pdb)
5248

5349
\item[ihooks.py]
54-
--- Import hook support (for rexec)
50+
--- Import hook support (for \refmodule{rexec}; may become obsolete)
5551
\end{description}
5652

5753

@@ -77,17 +73,14 @@ \section{Multimedia}
7773

7874
\begin{description}
7975
\item[audiodev.py]
80-
--- Plays audio files
81-
82-
\item[sunau.py]
83-
--- parse Sun and NeXT audio files
76+
--- Platform-independent API for playing audio data
8477

8578
\item[sunaudio.py]
86-
--- interpret sun audio headers
79+
--- interpret sun audio headers (may become obsolete or a tool/demo)
8780

8881
\item[toaiff.py]
8982
--- Convert "arbitrary" sound files to AIFF files; should probably
90-
become a tool or demo
83+
become a tool or demo. Requires the external program \program{sox}.
9184
\end{description}
9285

9386

@@ -98,10 +91,11 @@ \section{Oddities}
9891

9992
\begin{description}
10093
\item[find.py]
101-
--- find files matching pattern in directory tree
94+
--- find files matching pattern in directory tree (may become a demo
95+
or tool, or possibly obsolete)
10296

10397
\item[grep.py]
104-
--- grep
98+
--- grep (may become a demo or tool)
10599

106100
\item[mutex.py]
107101
--- Mutual exclusion --- for use with module sched
@@ -128,15 +122,17 @@ \section{Obsolete}
128122

129123
\begin{description}
130124
\item[newdir.py]
131-
--- New dir() function (the standard dir() is now just as good)
125+
--- New \function{dir()} function (the standard \function{dir()} is
126+
now just as good)
132127

133128
\item[addpack.py]
134129
--- standard support for "packages"
135130

136131
\item[codehack.py]
137132
--- Extract function name or line number from a function
138-
code object (these are now accessible as attributes: co.co_name,
139-
func.func_name, co.co_firstlineno).
133+
code object (these are now accessible as attributes:
134+
\member{co.co_name}, \member{func.func_name},
135+
\member{co.co_firstlineno}).
140136

141137
\item[dump.py]
142138
--- Print python code that reconstructs a variable
@@ -149,7 +145,7 @@ \section{Obsolete}
149145

150146
\item[lockfile.py]
151147
--- wrapper around FCNTL file locking (use
152-
\function{fcntl.lockf()}/\function{flock()} intead)
148+
\function{fcntl.lockf()}/\function{flock()} intead; see \refmodule{fcntl})
153149

154150
\item[poly.py]
155151
--- Polynomials
@@ -176,7 +172,9 @@ \section{Obsolete}
176172
\end{description}
177173

178174
The following modules were documented in previous versions of this
179-
manual, but are now considered obsolete:
175+
manual, but are now considered obsolete. The source for the
176+
documentation is still available as part of the documentation source
177+
archive.
180178

181179
\begin{description}
182180
\item[ni]
@@ -195,9 +193,6 @@ \section{Obsolete}
195193
\section{Extension modules}
196194

197195
\begin{description}
198-
\item[cursesmodule.c]
199-
--- Curses interface.
200-
201196
\item[dlmodule.c]
202197
--- A highly experimental and dangerous device for calling
203198
arbitrary \C{} functions in arbitrary shared libraries.
@@ -211,7 +206,8 @@ \section{Extension modules}
211206
platform-independent GUI instead.
212207
\end{description}
213208

214-
The following are SGI specific:
209+
The following are SGI specific, and may be out of touch with the
210+
current version of reality.
215211

216212
\begin{description}
217213
\item[clmodule.c]

0 commit comments

Comments
 (0)