]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-101100: Fix Sphinx reference warnings in the glossary (GH-114729) (#114970)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 3 Feb 2024 18:51:56 +0000 (19:51 +0100)
committerGitHub <noreply@github.com>
Sat, 3 Feb 2024 18:51:56 +0000 (18:51 +0000)
gh-101100: Fix Sphinx reference warnings in the glossary (GH-114729)
(cherry picked from commit ab76d37948fd506af44762dc1c3e32f27d1327a8)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Doc/glossary.rst

index 7dd178d5ad34f9b88992185f9386f907d3d3ba5e..f520df5de049b3402ca6103686399fcad2af36d5 100644 (file)
@@ -350,7 +350,7 @@ Glossary
    docstring
       A string literal which appears as the first expression in a class,
       function or module.  While ignored when the suite is executed, it is
-      recognized by the compiler and put into the :attr:`__doc__` attribute
+      recognized by the compiler and put into the :attr:`!__doc__` attribute
       of the enclosing class, function or module.  Since it is available via
       introspection, it is the canonical place for documentation of the
       object.
@@ -1101,10 +1101,12 @@ Glossary
       The :class:`collections.abc.Sequence` abstract base class
       defines a much richer interface that goes beyond just
       :meth:`~object.__getitem__` and :meth:`~object.__len__`, adding
-      :meth:`count`, :meth:`index`, :meth:`~object.__contains__`, and
+      :meth:`!count`, :meth:`!index`, :meth:`~object.__contains__`, and
       :meth:`~object.__reversed__`. Types that implement this expanded
       interface can be registered explicitly using
-      :func:`~abc.ABCMeta.register`.
+      :func:`~abc.ABCMeta.register`. For more documentation on sequence
+      methods generally, see
+      :ref:`Common Sequence Operations <typesseq-common>`.
 
    set comprehension
       A compact way to process all or part of the elements in an iterable and