[Python-checkins] [3.12] Resolve reference warnings in faq/programming.rst (GH-108150) (#108170)
Yhg1s
webhook-mailer at python.org
Sun Aug 20 10:44:46 EDT 2023
https://github.com/python/cpython/commit/7f5a741a28a7b87c9cdb1db87fcb3f0b9ed8ac2a
commit: 7f5a741a28a7b87c9cdb1db87fcb3f0b9ed8ac2a
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Yhg1s <thomas at python.org>
date: 2023-08-20T16:44:43+02:00
summary:
[3.12] Resolve reference warnings in faq/programming.rst (GH-108150) (#108170)
Resolve reference warnings in faq/programming.rst (GH-108150)
(cherry picked from commit a390ec20f5a85b9c16e8708f117667783d08863c)
Co-authored-by: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
files:
M Doc/faq/programming.rst
M Doc/tools/.nitignore
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index ab5618db84f77..f43f69b8a1ea9 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -454,7 +454,7 @@ There are two factors that produce this result:
(the list), and both ``x`` and ``y`` refer to it.
2) Lists are :term:`mutable`, which means that you can change their content.
-After the call to :meth:`~list.append`, the content of the mutable object has
+After the call to :meth:`!append`, the content of the mutable object has
changed from ``[]`` to ``[10]``. Since both the variables refer to the same
object, using either name accesses the modified value ``[10]``.
@@ -1397,7 +1397,7 @@ To see why this happens, you need to know that (a) if an object implements an
:meth:`~object.__iadd__` magic method, it gets called when the ``+=`` augmented
assignment
is executed, and its return value is what gets used in the assignment statement;
-and (b) for lists, :meth:`!__iadd__` is equivalent to calling :meth:`~list.extend` on the list
+and (b) for lists, :meth:`!__iadd__` is equivalent to calling :meth:`!extend` on the list
and returning the list. That's why we say that for lists, ``+=`` is a
"shorthand" for :meth:`!list.extend`::
@@ -1903,7 +1903,7 @@ identity tests. This prevents the code from being confused by objects such as
``float('NaN')`` that are not equal to themselves.
For example, here is the implementation of
-:meth:`collections.abc.Sequence.__contains__`::
+:meth:`!collections.abc.Sequence.__contains__`::
def __contains__(self, value):
for v in self:
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index d55b611a05575..a0a121b4b9dbe 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -28,7 +28,6 @@ Doc/extending/newtypes.rst
Doc/faq/design.rst
Doc/faq/gui.rst
Doc/faq/library.rst
-Doc/faq/programming.rst
Doc/glossary.rst
Doc/howto/descriptor.rst
Doc/howto/enum.rst
More information about the Python-checkins
mailing list