From: Berker Peksag <berker.peksag@gmail.com>
Date: Wed, 7 Jan 2015 19:15:02 +0000 (+0200)
Subject: Issue #20487: Clarify meaning of "side effect" in the magic mock documentation.
X-Git-Tag: v3.4.3rc1~166
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=283f1aa881af1c887fa90af914b51577c1b34461;p=python

Issue #20487: Clarify meaning of "side effect" in the magic mock documentation.

Patch by A.M. Kuchling.
---

diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index f92353cdbf..b242438cf4 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -1678,9 +1678,10 @@ For example:
    >>> object() in mock
    False
 
-The two equality method, :meth:`__eq__` and :meth:`__ne__`, are special.
-They do the default equality comparison on identity, using a side
-effect, unless you change their return value to return something else:
+The two equality methods, :meth:`__eq__` and :meth:`__ne__`, are special.
+They do the default equality comparison on identity, using the
+:attr:`~Mock.side_effect` attribute, unless you change their return value to
+return something else::
 
    >>> MagicMock() == 3
    False