https://github.com/python/cpython/commit/65cf5dce11a38e327b9b0abfca279d650452b34f
commit: 65cf5dce11a38e327b9b0abfca279d650452b34f
branch: main
author: Erlend E. Aasland <[email protected]>
committer: erlend-aasland <[email protected]>
date: 2024-01-26T11:15:34+01:00
summary:
Docs: rework dbm introduction (#114551)
- add refs to other parts of the docs (dict, bytes, etc.)
- clarify whichdb() return value by using list markup
- silence refs to example or generic submodule methods (keys, get, etc.)
files:
M Doc/library/dbm.rst
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst
index 0a9d28a41c6d7a..1a8e0158fcdbd5 100644
--- a/Doc/library/dbm.rst
+++ b/Doc/library/dbm.rst
@@ -28,10 +28,11 @@ the Oracle Berkeley DB.
available --- :mod:`dbm.gnu`, :mod:`dbm.ndbm` or :mod:`dbm.dumb` --- should
be used to open a given file.
- Returns one of the following values: ``None`` if the file can't be opened
- because it's unreadable or doesn't exist; the empty string (``''``) if the
- file's format can't be guessed; or a string containing the required module
- name, such as ``'dbm.ndbm'`` or ``'dbm.gnu'``.
+ Return one of the following values:
+
+ * ``None`` if the file can't be opened because it's unreadable or doesn't
exist
+ * the empty string (``''``) if the file's format can't be guessed
+ * a string containing the required module name, such as ``'dbm.ndbm'`` or
``'dbm.gnu'``
.. versionchanged:: 3.11
Accepts :term:`path-like object` for filename.
@@ -74,13 +75,13 @@ the Oracle Berkeley DB.
modified by the prevailing umask).
-The object returned by :func:`.open` supports the same basic functionality as
-dictionaries; keys and their corresponding values can be stored, retrieved, and
-deleted, and the :keyword:`in` operator and the :meth:`keys` method are
-available, as well as :meth:`get` and :meth:`setdefault`.
+The object returned by :func:`open` supports the same basic functionality as a
+:class:`dict`; keys and their corresponding values can be stored, retrieved,
and
+deleted, and the :keyword:`in` operator and the :meth:`!keys` method are
+available, as well as :meth:`!get` and :meth:`!setdefault`.
.. versionchanged:: 3.2
- :meth:`get` and :meth:`setdefault` are now available in all database
modules.
+ :meth:`!get` and :meth:`!setdefault` are now available in all database
modules.
.. versionchanged:: 3.8
Deleting a key from a read-only database raises database module specific
error
@@ -89,7 +90,7 @@ available, as well as :meth:`get` and :meth:`setdefault`.
.. versionchanged:: 3.11
Accepts :term:`path-like object` for file.
-Key and values are always stored as bytes. This means that when
+Key and values are always stored as :class:`bytes`. This means that when
strings are used they are implicitly converted to the default encoding before
being stored.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
