Skip to content

Commit

Permalink
Docs: spell out sentence about ndbm/gdbm file formats (python#115470)
Browse files Browse the repository at this point in the history
  • Loading branch information
erlend-aasland committed Feb 14, 2024
1 parent 17773fc commit 49e8fdc
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions Doc/library/dbm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ the Oracle Berkeley DB.
The Unix file access mode of the file (default: octal ``0o666``),
used only when the database has to be created.

.. |incompat_note| replace::
The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
and can not be used interchangeably.

.. function:: open(file, flag='r', mode=0o666)

Open a database and return the corresponding database object.
Expand Down Expand Up @@ -205,7 +201,10 @@ The :mod:`dbm.gnu` module provides an interface to the :abbr:`GDBM (GNU dbm)`
library, similar to the :mod:`dbm.ndbm` module, but with additional
functionality like crash tolerance.

.. note:: |incompat_note|
.. note::

The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
and can not be used interchangeably.

.. exception:: error

Expand Down Expand Up @@ -314,7 +313,10 @@ The :mod:`dbm.ndbm` module provides an interface to the
This module can be used with the "classic" NDBM interface or the
:abbr:`GDBM (GNU dbm)` compatibility interface.

.. note:: |incompat_note|
.. note::

The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
and can not be used interchangeably.

.. warning::

Expand Down

0 comments on commit 49e8fdc

Please sign in to comment.