[Python-checkins] Remove note saying patch is straightforward (#18431)

Brian Curtin webhook-mailer at python.org
Mon Feb 10 12:47:25 EST 2020


https://github.com/python/cpython/commit/e00c1d0c45975c0e9367f05f8c68bb32d68c2fbf
commit: e00c1d0c45975c0e9367f05f8c68bb32d68c2fbf
branch: master
author: Brian Curtin <brian at python.org>
committer: GitHub <noreply at github.com>
date: 2020-02-10T10:47:17-07:00
summary:

Remove note saying patch is straightforward (#18431)

While `unittest.mock.patch` is a great thing, it is not straightforward.
If it were straightforward there wouldn't be such a huge amount of
documentation for it, and frankly, when myself and others who I've
read about often struggle to figure out what on earth `patch()` wants,
coming to the docs to read that it's straightforward is not helpful.

files:
M Doc/library/unittest.mock.rst

diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index 515bdd060a198..3643d1ad96ed1 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -1327,8 +1327,7 @@ patch
 
 .. note::
 
-    :func:`patch` is straightforward to use. The key is to do the patching in the
-    right namespace. See the section `where to patch`_.
+    The key is to do the patching in the right namespace. See the section `where to patch`_.
 
 .. function:: patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)
 



More information about the Python-checkins mailing list