diff options
| author | Erlend E. Aasland <erlend@python.org> | 2024-01-26 10:15:34 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-26 10:15:34 (GMT) |
| commit | 65cf5dce11a38e327b9b0abfca279d650452b34f (patch) | |
| tree | e27bd655ae714ad98ab0451627aca8abbada1cae | |
| parent | dcd28b5c35dda8e2cb7c5f66450f2aff0948c001 (diff) | |
| download | cpython-65cf5dce11a38e327b9b0abfca279d650452b34f.zip cpython-65cf5dce11a38e327b9b0abfca279d650452b34f.tar.gz cpython-65cf5dce11a38e327b9b0abfca279d650452b34f.tar.bz2 | |
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.)
| -rw-r--r-- | Doc/library/dbm.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 0a9d28a..1a8e015 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. |