diff options
author | Jesus Cea <jcea@jcea.es> | 2014-06-25 11:06:07 (GMT) |
---|---|---|
committer | Jesus Cea <jcea@jcea.es> | 2014-06-25 11:06:07 (GMT) |
commit | 0c4baa40ec73044b79d330e04b413ca04f3baedf (patch) | |
tree | c1f659003515e216c35feee583501cf8b2e0a51b | |
parent | 601d6ec693e65649569a78e23cb324cf632e8369 (diff) | |
parent | ac4b7f705a9194d9f5392f7aa7e4f66ac3e36f8b (diff) | |
download | cpython-0c4baa40ec73044b79d330e04b413ca04f3baedf.zip cpython-0c4baa40ec73044b79d330e04b413ca04f3baedf.tar.gz cpython-0c4baa40ec73044b79d330e04b413ca04f3baedf.tar.bz2 |
MERGE: Closes #20872: dbm/gdbm/ndbm close methods are not documented
-rw-r--r-- | Doc/library/dbm.rst | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index f5496d5..e6a82d6 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -222,6 +222,9 @@ supported. When the database has been opened in fast mode, this method forces any unwritten data to be written to the disk. + .. method:: gdbm.close() + + Close the ``gdbm`` database. :mod:`dbm.ndbm` --- Interface based on ndbm ------------------------------------------- @@ -253,7 +256,7 @@ to locate the appropriate header file to simplify building this module. .. function:: open(filename[, flag[, mode]]) - Open a dbm database and return a ``dbm`` object. The *filename* argument is the + Open a dbm database and return a ``ndbm`` object. The *filename* argument is the name of the database file (without the :file:`.dir` or :file:`.pag` extensions). The optional *flag* argument must be one of these values: @@ -278,6 +281,12 @@ to locate the appropriate header file to simplify building this module. database has to be created. It defaults to octal ``0o666`` (and will be modified by the prevailing umask). + In addition to the dictionary-like methods, ``ndbm`` objects + provide the following method: + + .. method:: ndbm.close() + + Close the ``ndbm`` database. :mod:`dbm.dumb` --- Portable DBM implementation @@ -325,9 +334,14 @@ The module defines the following: In addition to the methods provided by the :class:`collections.abc.MutableMapping` class, :class:`dumbdbm` objects - provide the following method: + provide the following methods: .. method:: dumbdbm.sync() Synchronize the on-disk directory and data files. This method is called by the :meth:`Shelve.sync` method. + + .. method:: dumbdbm.close() + + Close the ``dumbdbm`` database. + |