Skip to content

bpo-37094: Add example for TestCase.skipTest in unittest doc - #13645

Merged
miss-islington merged 5 commits into
python:masterfrom
MakDon:fix-unittest-doc
May 31, 2019
Merged

bpo-37094: Add example for TestCase.skipTest in unittest doc#13645
miss-islington merged 5 commits into
python:masterfrom
MakDon:fix-unittest-doc

Conversation

@MakDon

@MakDonMakDon commented May 29, 2019

Copy link
Copy Markdown
Contributor

Also includes other minor test skipping doc improvements.

https://bugs.python.org/issue37094

@csabella

Copy link
Copy Markdown
Contributor

Hi @MakDon, please create a bug tracker issue for this and link the bpo number in the title. Thanks!

@MakDon

Copy link
Copy Markdown
ContributorAuthor

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

@csabella

Copy link
Copy Markdown
Contributor

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. 🙂

@MakDon

Copy link
Copy Markdown
ContributorAuthor

@csabella Maybe you are right. I created an issue on issue tracker. Thanks.

@MakDonMakDon changed the title Add example for TestCase.skipTest in unittest docbpo-37094: Add example for TestCase.skipTest in unittest docMay 30, 2019
@csabella
csabella requested a review from zwareMay 31, 2019 00:49

@zwarezware left a comment

Copy link
Copy Markdown
Member

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!

Comment threadDoc/library/unittest.rst Outdated
# windows specific testing code
pass

def test_skip_me(self):

Copy link
Copy Markdown
Member

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).

Comment threadDoc/library/unittest.rst Outdated
Comment threadDoc/library/unittest.rst Outdated
@bedevere-bot

Copy link
Copy Markdown

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-Authored-By: Zachary Ware <zachary.ware@gmail.com>
@MakDon

Copy link
Copy Markdown
ContributorAuthor

@zware Thanks for your suggestions.
The document is still WIP.Please wait for a minute.
Thank your again!

Update unittest according @zware's suggestions.
@MakDon

Copy link
Copy Markdown
ContributorAuthor

I have made the requested changes; please review again.

@bedevere-bot

Copy link
Copy Markdown

Thanks for making the requested changes!

@zware: please review the changes made to this pull request.

@zwarezware left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MakDon

Copy link
Copy Markdown
ContributorAuthor

Cause Python 3.8.0b1 branch cut-off date moved to Monday, could i see this document update in 3.8? :D

@zware

Copy link
Copy Markdown
Member

There is no restriction on documentation improvements; this will apply to 3.7 and beyond :)

@miss-islington
miss-islington merged commit ffed76b into python:masterMay 31, 2019
@miss-islington

Copy link
Copy Markdown
Contributor

Thanks @MakDon for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 31, 2019
…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>
@bedevere-bot

Copy link
Copy Markdown

GH-13701 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request May 31, 2019
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>
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@MakDon@csabella@bedevere-bot@zware@miss-islington@auvipy@the-knights-who-say-ni