Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libwhichdb.tex @ 21467:4e35fa5d5708 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 99681ee86698
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{whichdb} ---
10251
d83935d14084 Shorten a few section titles.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
2 Guess which DBM module created a database}
d83935d14084 Shorten a few section titles.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{standard}{whichdb}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
5 \modulesynopsis{Guess which DBM-style module created a given database.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
6
5261
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 The single function in this module attempts to guess which of the
10658
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
9 several simple database modules available--\refmodule{dbm},
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
10 \refmodule{gdbm}, or \refmodule{dbhash}--should be used to open a
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
11 given file.
5261
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
12
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 \begin{funcdesc}{whichdb}{filename}
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 Returns one of the following values: \code{None} if the file can't be
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 opened because it's unreadable or doesn't exist; the empty string
10658
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
16 (\code{''}) if the file's format can't be guessed; or a string
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
17 containing the required module name, such as \code{'dbm'} or
99681ee86698 Make the names of the referenced modules hyperlinks; they had not been
Fred Drake <fdrake@acm.org>
parents: 10251
diff changeset
18 \code{'gdbm'}.
5261
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 \end{funcdesc}
72986b716824 New stuff by AMK.
Guido van Rossum <guido@python.org>
parents:
diff changeset
20