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

Skip to content

Commit e4694eb

Browse files
committed
Removed entries for several modules which have been documented.
Updated comments on several remaining modules.
1 parent 4c8d83f commit e4694eb

1 file changed

Lines changed: 55 additions & 72 deletions

File tree

Doc/lib/libundoc.tex

Lines changed: 55 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ \section{Frameworks}
1313
effort spent.
1414

1515
\begin{description}
16-
\item[Tkinter.py]
16+
\item[\module{Tkinter}]
1717
--- Interface to Tcl/Tk for graphical user interfaces;
1818
Fredrik Lundh is working on this one! See \emph{An Introduction to
1919
Tkinter} at \url{http://www.pythonware.com/library/} for on-line
2020
reference material.
2121

22-
\item[Tkdnd.py]
22+
\item[\module{Tkdnd}]
2323
--- Drag-and-drop support for \module{Tkinter}.
2424

25-
\item[test]
25+
\item[\module{test}]
2626
--- Regression testing framework. This is used for the Python
2727
regression test, but is useful for other Python libraries as well.
2828
This is a package rather than a module.
@@ -34,17 +34,18 @@ \section{Miscellaneous useful utilities}
3434
Some of these are very old and/or not very robust; marked with ``hmm.''
3535

3636
\begin{description}
37-
\item[dircmp.py]
37+
\item[\module{dircmp}]
3838
--- class to build directory diff tools on (may become a demo or tool)
3939

40-
\item[pty.py]
41-
--- Pseudo terminal utilities
42-
43-
\item[bdb.py]
40+
\item[\module{bdb}]
4441
--- A generic Python debugger base class (used by pdb)
4542

46-
\item[ihooks.py]
43+
\item[\module{ihooks}]
4744
--- Import hook support (for \refmodule{rexec}; may become obsolete)
45+
46+
\item[\module{tzparse}]
47+
--- Parse a timezone specification (unfinished; may disappear in the
48+
future)
4849
\end{description}
4950

5051

@@ -55,59 +56,32 @@ \section{Platform specific modules}
5556
document these.
5657

5758
\begin{description}
58-
\item[dospath.py]
59+
\item[\module{dospath}]
5960
--- implementation of \module{os.path} on MS-DOS
6061

61-
\item[ntpath.py]
62+
\item[\module{ntpath}]
6263
--- implementation on \module{os.path} on 32-bit Windows
6364

64-
\item[posixpath.py]
65+
\item[\module{posixpath}]
6566
--- implementation on \module{os.path} on \POSIX{}
6667
\end{description}
6768

6869

6970
\section{Multimedia}
7071

7172
\begin{description}
72-
\item[audiodev.py]
73+
\item[\module{audiodev}]
7374
--- Platform-independent API for playing audio data
7475

75-
\item[sunaudio.py]
76+
\item[\module{sunaudio}]
7677
--- interpret sun audio headers (may become obsolete or a tool/demo)
7778

78-
\item[toaiff.py]
79+
\item[\module{toaiff}]
7980
--- Convert "arbitrary" sound files to AIFF files; should probably
8081
become a tool or demo. Requires the external program \program{sox}.
8182
\end{description}
8283

8384

84-
\section{Oddities}
85-
86-
These modules are probably also obsolete, or just not very useful.
87-
Some of these may be made into tools or demos in future releases.
88-
89-
\begin{description}
90-
\item[find.py]
91-
--- find files matching pattern in directory tree (may become a demo
92-
or tool, or possibly obsolete)
93-
94-
\item[grep.py]
95-
--- grep (may become a demo or tool)
96-
97-
\item[mutex.py]
98-
--- Mutual exclusion --- for use with module sched
99-
100-
\item[packmail.py]
101-
--- create a self-unpacking \UNIX{} shell archive
102-
103-
\item[sched.py]
104-
--- event scheduler class
105-
106-
\item[tzparse.py]
107-
--- Parse a timezone specification (unfinished)
108-
\end{description}
109-
110-
11185
\section{Obsolete}
11286

11387
These modules are not on the standard module search path;
@@ -118,70 +92,86 @@ \section{Obsolete}
11892
possibly using \envvar{PYTHONPATH}.
11993

12094
\begin{description}
121-
\item[newdir.py]
95+
\item[\module{newdir}]
12296
--- New \function{dir()} function (the standard \function{dir()} is
12397
now just as good)
12498

125-
\item[addpack.py]
126-
--- standard support for "packages"
99+
\item[\module{addpack}]
100+
--- alternate approach to packages
127101

128-
\item[codehack.py]
102+
\item[\module{codehack}]
129103
--- Extract function name or line number from a function
130104
code object (these are now accessible as attributes:
131105
\member{co.co_name}, \member{func.func_name},
132106
\member{co.co_firstlineno}).
133107

134-
\item[dump.py]
108+
\item[\module{dump}]
135109
--- Print python code that reconstructs a variable
136110

137-
\item[fmt.py]
111+
\item[\module{fmt}]
138112
--- text formatting abstractions (too slow)
139113

140-
\item[Para.py]
114+
\item[\module{Para}]
141115
--- helper for fmt.py
142116

143-
\item[lockfile.py]
117+
\item[\module{lockfile}]
144118
--- wrapper around FCNTL file locking (use
145119
\function{fcntl.lockf()}/\function{flock()} intead; see \refmodule{fcntl})
146120

147-
\item[poly.py]
121+
\item[\module{poly}]
148122
--- Polynomials
149123

150-
\item[tb.py]
124+
\item[\module{tb}]
151125
--- Print tracebacks, with a dump of local variables (use
152126
\function{pdb.pm()} or \refmodule{traceback} instead)
153127

154-
\item[timingmodule]
128+
\item[\module{timing}]
155129
--- Measure time intervals to high resolution (use
156130
\function{time.clock()} instead). (This is an extension module.)
157131

158-
\item[util.py]
132+
\item[\module{util}]
159133
--- Useful functions that don't fit elsewhere.
160134

161-
\item[wdb.py]
135+
\item[\module{wdb}]
162136
--- A primitive windowing debugger based on STDWIN.
163137

164-
\item[whatsound.py]
138+
\item[\module{whatsound}]
165139
--- Recognize sound files; use \refmodule{sndhdr} instead.
166140

167-
\item[zmod.py]
141+
\item[\module{zmod}]
168142
--- Compute properties of mathematical "fields"
169143
\end{description}
170144

145+
146+
The following modules are obsolete, but are likely re-surface as tools
147+
or scripts.
148+
149+
\begin{description}
150+
\item[\module{find}]
151+
--- find files matching pattern in directory tree
152+
153+
\item[\module{grep}]
154+
--- grep
155+
156+
\item[\module{packmail}]
157+
--- create a self-unpacking \UNIX{} shell archive
158+
\end{description}
159+
160+
171161
The following modules were documented in previous versions of this
172162
manual, but are now considered obsolete. The source for the
173163
documentation is still available as part of the documentation source
174164
archive.
175165

176166
\begin{description}
177-
\item[ni]
167+
\item[\module{ni}]
178168
--- Import modules in ``packages.'' Basic package support is now
179169
built in.
180170

181-
\item[rand]
171+
\item[\module{rand}]
182172
--- Old interface to the random number generator.
183173

184-
\item[soundex]
174+
\item[\module{soundex}]
185175
--- Algorithm for collapsing names which sound similar to a shared
186176
key. (This is an extension module.)
187177
\end{description}
@@ -190,27 +180,20 @@ \section{Obsolete}
190180
\section{Extension modules}
191181

192182
\begin{description}
193-
\item[dlmodule.c]
194-
--- A highly experimental and dangerous device for calling
195-
arbitrary \C{} functions in arbitrary shared libraries.
196-
197-
\item[nismodule.c]
198-
--- NIS (a.k.a. Sun's Yellow Pages) interface.
199-
200-
\item[stdwinmodule.c]
183+
\item[\module{stdwin}]
201184
--- Interface to STDWIN (an old, unsupported
202-
platform-independent GUI package). Obsolete; use Tkinter for a
203-
platform-independent GUI instead.
185+
platform-independent GUI package). Obsolete; use \module{Tkinter} for
186+
a platform-independent GUI instead.
204187
\end{description}
205188

206189
The following are SGI specific, and may be out of touch with the
207190
current version of reality.
208191

209192
\begin{description}
210-
\item[clmodule.c]
193+
\item[\module{cl}]
211194
--- Interface to the SGI compression library.
212195

213-
\item[svmodule.c]
196+
\item[\module{sv}]
214197
--- Interface to the ``simple video'' board on SGI Indigo
215198
(obsolete hardware).
216199
\end{description}

0 commit comments

Comments
 (0)