]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` (GH-112836) (#112869)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 8 Dec 2023 12:38:40 +0000 (13:38 +0100)
committerGitHub <noreply@github.com>
Fri, 8 Dec 2023 12:38:40 +0000 (12:38 +0000)
gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` (GH-112836)
(cherry picked from commit 3cdcc2edf81c7be4c88d4f273947ce29f916f49a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Doc/library/shelve.rst
Doc/tools/.nitignore

index 219219af6fd87f166ec02ed9cc6828b8a6c4d5ea..88802d717d738387407b6ba3956d973523368582 100644 (file)
@@ -149,13 +149,14 @@ Restrictions
 
 .. class:: BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
 
-   A subclass of :class:`Shelf` which exposes :meth:`first`, :meth:`!next`,
-   :meth:`previous`, :meth:`last` and :meth:`set_location` which are available
-   in the third-party :mod:`bsddb` module from `pybsddb
+   A subclass of :class:`Shelf` which exposes :meth:`!first`, :meth:`!next`,
+   :meth:`!previous`, :meth:`!last` and :meth:`!set_location` methods.
+   These are available
+   in the third-party :mod:`!bsddb` module from `pybsddb
    <https://www.jcea.es/programacion/pybsddb.htm>`_ but not in other database
    modules.  The *dict* object passed to the constructor must support those
    methods.  This is generally accomplished by calling one of
-   :func:`bsddb.hashopen`, :func:`bsddb.btopen` or :func:`bsddb.rnopen`.  The
+   :func:`!bsddb.hashopen`, :func:`!bsddb.btopen` or :func:`!bsddb.rnopen`.  The
    optional *protocol*, *writeback*, and *keyencoding* parameters have the same
    interpretation as for the :class:`Shelf` class.
 
index c15f3b57f56120c546e2002a3bcf76f239259877..68fd9810b3929e779a9ea8bdf452d1064cd293cd 100644 (file)
@@ -89,7 +89,6 @@ Doc/library/readline.rst
 Doc/library/resource.rst
 Doc/library/rlcompleter.rst
 Doc/library/select.rst
-Doc/library/shelve.rst
 Doc/library/signal.rst
 Doc/library/smtplib.rst
 Doc/library/socket.rst