Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

SF bug #651149: Review libshelve.tex when possible 

Minor fixes to markup, spelling, parameter names, and abbreviations.
This commit is contained in:
Raymond Hettinger 2003-01-04 01:53:38 +00:00
parent 1061e7270b
commit 2ca243368f
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Doc/lib/libshelve.tex
View File

@ -44,7 +44,7 @@ Restrictions:
\item \item
The choice of which database package will be used The choice of which database package will be used
(e.g. \refmodule{dbm} or \refmodule{gdbm}) depends on which interface (such as \refmodule{dbm} or \refmodule{gdbm}) depends on which interface
is available. Therefore it is not safe to open the database directly is available. Therefore it is not safe to open the database directly
using \refmodule{dbm}. The database is also (unfortunately) subject using \refmodule{dbm}. The database is also (unfortunately) subject
to the limitations of \refmodule{dbm}, if it is used --- this means to the limitations of \refmodule{dbm}, if it is used --- this means
@ -72,14 +72,14 @@ requires knowledge about the database implementation used.
\begin{classdesc}{Shelf}{dict\optional{, binary=False}} \begin{classdesc}{Shelf}{dict\optional{, binary=False}}
A subclass of \class{UserDict.DictMixin} which stores pickled values in the A subclass of \class{UserDict.DictMixin} which stores pickled values in the
\var{dict} object. If the \var{binary} parameter is \constant{True}, binary \var{dict} object. If the \var{binary} parameter is \code{True}, binary
pickles will be used. This can provide much more compact storage than plain pickles will be used. This can provide much more compact storage than plain
text pickles, depending on the nature of the objects stored in the databse. text pickles, depending on the nature of the objects stored in the database.
\end{classdesc} \end{classdesc}
\begin{classdesc}{BsdDbShelf}{dict\optional{, binary=False}} \begin{classdesc}{BsdDbShelf}{dict\optional{, binary=False}}
A subclass of \class{Shelf} which exposes \method{first}, \method{next}, A subclass of \class{Shelf} which exposes \method{first}, \method{next},
{}\method{previous}, \method{last} and \method{set_location} which are \method{previous}, \method{last} and \method{set_location} which are
available in the \module{bsddb} module but not in other database modules. available in the \module{bsddb} module but not in other database modules.
The \var{dict} object passed to the constructor must support those methods. The \var{dict} object passed to the constructor must support those methods.
This is generally accomplished by calling one of \function{bsddb.hashopen}, This is generally accomplished by calling one of \function{bsddb.hashopen},
@ -88,8 +88,8 @@ This is generally accomplished by calling one of \function{bsddb.hashopen},
class. class.
\end{classdesc} \end{classdesc}
\begin{classdesc}{DbfilenameShelf}{dict\optional{, flag='c'}\optional{, binary=False}} \begin{classdesc}{DbfilenameShelf}{filename\optional{, flag='c'\optional{, binary=False}}}
A subclass of \class{Shelf} which accepts a filename instead of a dict-like A subclass of \class{Shelf} which accepts a \var{filename} instead of a dict-like
object. The underlying file will be opened using \function{anydbm.open}. object. The underlying file will be opened using \function{anydbm.open}.
By default, the file will be created and opened for both read and write. By default, the file will be created and opened for both read and write.
The optional \var{binary} parameter has the same interpretation as for the The optional \var{binary} parameter has the same interpretation as for the