From 668124782d70503631c60c59e4596887304653fb Mon Sep 17 00:00:00 2001 From: Alex Waygood Date: Fri, 8 Dec 2023 12:31:11 +0000 Subject: [PATCH] gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` (GH-112836) (cherry picked from commit 3cdcc2edf81c7be4c88d4f273947ce29f916f49a) Co-authored-by: Alex Waygood --- Doc/library/shelve.rst | 9 +++++---- Doc/tools/.nitignore | 1 - 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index 219219af6fd87f..88802d717d7383 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -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 `_ 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. diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 3b5bd6a108cd79..6a8fda9531aea1 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -97,7 +97,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