[Python-checkins] Resolve reference warnings in faq/programming.rst (#108150)

kumaraditya303 webhook-mailer at python.org
Sun Aug 20 09:53:31 EDT 2023


https://github.com/python/cpython/commit/a390ec20f5a85b9c16e8708f117667783d08863c
commit: a390ec20f5a85b9c16e8708f117667783d08863c
branch: main
author: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
committer: kumaraditya303 <kumaraditya at python.org>
date: 2023-08-20T19:23:28+05:30
summary:

Resolve reference warnings in faq/programming.rst (#108150)

files:
M Doc/faq/programming.rst
M Doc/tools/.nitignore

diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index 6e1812504a184..0a88c5f6384f2 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 f7e454af62c87..ac5b54b38f37c 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -27,7 +27,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