From: Pierre Equoy <pierre.equoy@canonical.com>
Date: Fri, 12 Jan 2024 22:54:36 +0000 (+0800)
Subject: Link to the glossary for "magic methods" in ``MagicMock`` (#111292)
X-Git-Tag: v3.13.0a3~61
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e97da8677f7bbc6d970e230d334cd646ab662af1;p=thirdparty%2FPython%2Fcpython.git

Link to the glossary for "magic methods" in ``MagicMock`` (#111292)

The MagicMock documentation mentions magic methods several times without
actually pointing to the term in the glossary. This can be helpful for
people to fully understand what those magic methods are.
---

diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index f1cc482c5cfe..eca20b94ec8e 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -2009,8 +2009,8 @@ Mocking Magic Methods
 ~~~~~~~~~~~~~~~~~~~~~
 
 :class:`Mock` supports mocking the Python protocol methods, also known as
-"magic methods". This allows mock objects to replace containers or other
-objects that implement Python protocols.
+:term:`"magic methods" <magic method>`. This allows mock objects to replace
+containers or other objects that implement Python protocols.
 
 Because magic methods are looked up differently from normal methods [#]_, this
 support has been specially implemented. This means that only specific magic
@@ -2108,8 +2108,8 @@ There are two ``MagicMock`` variants: :class:`MagicMock` and :class:`NonCallable
 .. class:: MagicMock(*args, **kw)
 
    ``MagicMock`` is a subclass of :class:`Mock` with default implementations
-   of most of the magic methods. You can use ``MagicMock`` without having to
-   configure the magic methods yourself.
+   of most of the :term:`magic methods <magic method>`. You can use
+   ``MagicMock`` without having to configure the magic methods yourself.
 
    The constructor parameters have the same meaning as for :class:`Mock`.