gh-122196: Clarify, reorder language for TestCase(object) #24465
Conversation
The former docstring inappropriately uses the term 'fixture' before introducing or defining the term. Therefore, I have re-arranged the description so that the definition comes before the usage. Additional semantic changes made to be clearer, more understandable, and linear.
|
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). Recognized GitHub usernameWe couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames: This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
I did not know about this requirement until I made the pull-request. Thank you to the bot for notifying me. 🤖 I have now registered and followed the steps outlined in the CPython devguide as indicated.
|
|
This PR is stale because it has been open for 30 days with no activity. |
|
@mavaddat CLA signed tag added |
|
Is this PR still relevant? |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Lib/unittest/case.py
Outdated
| Test authors should subclass this TestCase class for their own tests. | ||
| Testing code may be placed in subclass method named 'runTest'; | ||
| alternatively, invoke unittest.main() from the subclass's "__name__ guard" | ||
| section to run all methods defined in the test class. To achieve more | ||
| precise subclass test invocation see below (viz., constructor kwarg). |
There was a problem hiding this comment.
The runTest form is far rarer, should we cover it second?
There was a problem hiding this comment.
I rewrote the docs according to your suggestion.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Misc/NEWS.d/next/Documentation/2024-07-23-20-18-31.gh-issue-122196.pYwrvo.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Re-order recommendations as suggested by python#24465 (comment)
|
The following commit authors need to sign the Contributor License Agreement: |
The former docstring inappropriately uses the term 'fixture' before introducing or defining the term. Therefore, I have re-arranged the description so that the definition comes before the usage. Additional semantic changes made to be clearer, more understandable, and linear.
TestCase(object)is prior to its definition #122196