]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Link to the glossary for "magic methods" in ``MagicMock`` (GH-111292) (#114002)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 12 Jan 2024 23:00:50 +0000 (00:00 +0100)
committerGitHub <noreply@github.com>
Fri, 12 Jan 2024 23:00:50 +0000 (23:00 +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 27adfd9ae01095ae8ec2a29c124bd93eaeba603e..d11307447b26a30c38cc4bb85c0f94320519d253 100644 (file)
@@ -1960,8 +1960,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
@@ -2059,8 +2059,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`.