-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
bpo-37094: Add example for TestCase.skipTest in unittest doc #13645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hi @MakDon, please create a bug tracker issue for this and link the bpo number in the title. Thanks! |
Hi @csabella , according to Python Developer’s Guide, Trivial issues (e.g. typo fixes) do not require any issue to be created. It's just a document updating, so maybe it is not important enough to create an issue on issues tracker. Thank you for your reply! :D |
Yes, it's not obvious what trivial means, but it's really just a pull request with only a few typo fixes. Adding an additional example is more than trivial. Also, some core devs primary way of discovering issues is through the bug tracker, so adding a PR without a bug tracker link increases that likelihood of a change not being reviewed. It's usually better to have a bpo number than to not have one. 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a little bit of cleanup, but I think this will end up as a nice improvement!
Doc/library/unittest.rst
Outdated
@@ -531,16 +532,20 @@ Basic skipping looks like this:: | |||
# windows specific testing code | |||
pass | |||
|
|||
def test_skip_me(self): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you take my second suggestion for the body of this example method, it could use a better name ("test_maybe_skipped" or similar, perhaps).
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 |
Co-Authored-By: Zachary Ware <zachary.ware@gmail.com>
@zware Thanks for your suggestions. |
Update unittest according @zware's suggestions.
I have made the requested changes; please review again. |
Thanks for making the requested changes! @zware: please review the changes made to this pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Cause Python 3.8.0b1 branch cut-off date moved to Monday, could i see this document update in 3.8? :D |
There is no restriction on documentation improvements; this will apply to 3.7 and beyond :) |
Thanks @MakDon for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7. |
…H-13645) Also includes other minor test skipping doc improvements. https://bugs.python.org/issue37094 (cherry picked from commit ffed76b) Co-authored-by: Makdon <makdon@makdon.me>
GH-13701 is a backport of this pull request to the 3.7 branch. |
Also includes other minor test skipping doc improvements. https://bugs.python.org/issue37094 (cherry picked from commit ffed76b) Co-authored-by: Makdon <makdon@makdon.me>
…H-13645) Also includes other minor test skipping doc improvements. https://bugs.python.org/issue37094
Also includes other minor test skipping doc improvements.
https://bugs.python.org/issue37094