Fix parameter names in assertIn() docs #18829
Conversation
These names are also shown with the help() function, and are immediately understandable, contrary to 1st and 2nd.
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA). CLA MissingOur records indicate the following people have not signed the CLA: For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. If you have recently signed the CLA, please wait at least one business day You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
There was a problem hiding this comment.
Welcome @Cito and thanks for the PR.
Good catch, I verified the parameter name fix in the source code (which is used to generate the help() page); LGTM.
The only suggestion that I'd make would be to adjust the name of the PR to Fix parameter names in assertIn() docs to make its purpose more immediately clear. This will likely help to reduce the review period.
Regarding the CLA, you may have to manually update the status through the heroku app if you already signed it 24-48+ hours ago. For most things beyond a minor typo fix, it typically has to be signed before the core devs will consider merging the PR (for licensing/legal reasons).
|
Thanks for the feedback @aeros - fixed the PR name and signed the CLA now, will update when it's verified. |
|
There are other helpers that are also inconsistent with their function definition. See https://bugs.python.org/issue10573 for a discussion. |
|
Thanks @Cito for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8. |
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". (cherry picked from commit a388bbd) Co-authored-by: Christoph Zwerschke <cito@online.de>
|
GH-19563 is a backport of this pull request to the 3.8 branch. |
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". (cherry picked from commit a388bbd) Co-authored-by: Christoph Zwerschke <cito@online.de>
|
GH-19564 is a backport of this pull request to the 3.7 branch. |
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". (cherry picked from commit a388bbd) Co-authored-by: Christoph Zwerschke <cito@online.de>
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". (cherry picked from commit a388bbd) Co-authored-by: Christoph Zwerschke <cito@online.de>
* master: (1985 commits) bpo-40179: Fix translation of #elif in Argument Clinic (pythonGH-19364) bpo-35967: Skip test with `uname -p` on Android (pythonGH-19577) bpo-40257: Improve help for the typing module (pythonGH-19546) Fix two typos in multiprocessing (pythonGH-19571) bpo-40286: Use random.randbytes() in tests (pythonGH-19575) bpo-40286: Makes simpler the relation between randbytes() and getrandbits() (pythonGH-19574) bpo-39894: Route calls from pathlib.Path.samefile() to os.stat() via the path accessor (pythonGH-18836) bpo-39897: Remove needless `Path(self.parent)` call, which makes `is_mount()` misbehave in `Path` subclasses. (pythonGH-18839) bpo-40282: Allow random.getrandbits(0) (pythonGH-19539) bpo-40302: UTF-32 encoder SWAB4() macro use a|b rather than a+b (pythonGH-19572) bpo-40302: Replace PY_INT64_T with int64_t (pythonGH-19573) bpo-40286: Add randbytes() method to random.Random (pythonGH-19527) bpo-39901: Move `pathlib.Path.owner()` and `group()` implementations into the path accessor. (pythonGH-18844) bpo-40300: Allow empty logging.Formatter.default_msec_format. (pythonGH-19551) bpo-40302: Add pycore_byteswap.h header file (pythonGH-19552) bpo-40287: Fix SpooledTemporaryFile.seek() return value (pythonGH-19540) Minor modernization and readability improvement to the tokenizer example (pythonGH-19558) bpo-40294: Fix _asyncio when module is loaded/unloaded multiple times (pythonGH-19542) Fix parameter names in assertIn() docs (pythonGH-18829) bpo-39793: use the same domain on make_msgid tests (python#18698) ...
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".
Automerge-Triggered-By: @aeros