]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] Link to the glossary for "magic methods" in ``MagicMock`` (GH-111292) (#114003)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 12 Jan 2024 23:01:09 +0000 (00:01 +0100)
committerGitHub <noreply@github.com>
Fri, 12 Jan 2024 23:01:09 +0000 (23:01 +0000)
Link to the glossary for "magic methods" in ``MagicMock`` (GH-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.
(cherry picked from commit e97da8677f7bbc6d970e230d334cd646ab662af1)

Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
Doc/library/unittest.mock.rst

index 098ba2d7827ab1ae35f8f88d4b1bf1d632ad3c69..75d8a6c9bdee3fc5e42b03996b422344523132c1 100644 (file)
@@ -1958,8 +1958,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
@@ -2057,8 +2057,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`.