[Python-checkins] Fix parameter names in assertIn() docs (GH-18829)

Christoph Zwerschke webhook-mailer at python.org
Thu Apr 16 21:55:01 EDT 2020


https://github.com/python/cpython/commit/a388bbd3f129364c39843f63e92f08bc53c71905
commit: a388bbd3f129364c39843f63e92f08bc53c71905
branch: master
author: Christoph Zwerschke <cito at online.de>
committer: GitHub <noreply at github.com>
date: 2020-04-16T18:54:53-07:00
summary:

Fix parameter names in assertIn() docs (GH-18829)



The names "member" and "container" for the arguments are also used in the module and shown with the help() function, and are immediately understandable in this context, contrary to "first" and "second".

files:
M Doc/library/unittest.rst

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index e2e4f2cdc220a..b2e16cf331e03 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -910,10 +910,10 @@ Test cases
       .. versionadded:: 3.1
 
 
-   .. method:: assertIn(first, second, msg=None)
-               assertNotIn(first, second, msg=None)
+   .. method:: assertIn(member, container, msg=None)
+               assertNotIn(member, container, msg=None)
 
-      Test that *first* is (or is not) in *second*.
+      Test that *member* is (or is not) in *container*.
 
       .. versionadded:: 3.1
 



More information about the Python-checkins mailing list