Docs: spell out sentence about ndbm/gdbm file formats (#115470)

This commit is contained in:
Erlend E. Aasland 2024-02-14 19:03:20 +01:00 committed by GitHub
parent 17773fcb86
commit 49e8fdc1df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -61,10 +61,6 @@ the Oracle Berkeley DB.
The Unix file access mode of the file (default: octal ``0o666``), The Unix file access mode of the file (default: octal ``0o666``),
used only when the database has to be created. 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) .. function:: open(file, flag='r', mode=0o666)
Open a database and return the corresponding database object. Open a database and return the corresponding database object.
@ -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 library, similar to the :mod:`dbm.ndbm` module, but with additional
functionality like crash tolerance. 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 .. exception:: error
@ -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 This module can be used with the "classic" NDBM interface or the
:abbr:`GDBM (GNU dbm)` compatibility interface. :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:: .. warning::