summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAlex Waygood <Alex.Waygood@Gmail.com>2023-12-08 12:31:11 (GMT)
committerGitHub <noreply@github.com>2023-12-08 12:31:11 (GMT)
commit3cdcc2edf81c7be4c88d4f273947ce29f916f49a (patch)
tree6b620c9b31fea35736b0341c7701fe89557a1a55 /Doc
parentaefdebdef16b8e9e6c1c2a0a54d6cb25bd8e28dc (diff)
downloadcpython-3cdcc2edf81c7be4c88d4f273947ce29f916f49a.zip
cpython-3cdcc2edf81c7be4c88d4f273947ce29f916f49a.tar.gz
cpython-3cdcc2edf81c7be4c88d4f273947ce29f916f49a.tar.bz2
gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` (#112836)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/shelve.rst9
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst
index 219219a..88802d7 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
<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.
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 8a033f0..18dddb2 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -86,7 +86,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