summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-02-03 18:51:56 (GMT)
committerGitHub <noreply@github.com>2024-02-03 18:51:56 (GMT)
commit34ab494c74a461e9786720fb38defcf161f7c731 (patch)
tree6641baeb7b95d943acac982f7e9bf31d19d0a4da
parente846c88b37f4a7a076785f6f9f9150ecd6d4233b (diff)
downloadcpython-34ab494c74a461e9786720fb38defcf161f7c731.zip
cpython-34ab494c74a461e9786720fb38defcf161f7c731.tar.gz
cpython-34ab494c74a461e9786720fb38defcf161f7c731.tar.bz2
[3.11] gh-101100: Fix Sphinx reference warnings in the glossary (GH-114729) (#114970)
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>
-rw-r--r--Doc/glossary.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index 7dd178d..f520df5 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -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