Skip to content

Doc Fix: skipif's example description #3611

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jun 23, 2018
Merged

Doc Fix: skipif's example description #3611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1ac1ee6
Fixed text description above skipif's example
AdamEr8 Jun 21, 2018
5e56d77
Create prnum.trivial.rst
AdamEr8 Jun 22, 2018
40839b5
Rename prnum.trivial.rst to 3611.trivial.rst
AdamEr8 Jun 22, 2018
f883628
Changelog mistake
AdamEr8 Jun 22, 2018
4970f6d
Improve reason in skipif example
nicoddemus Jun 22, 2018
8cc2107
Improve changelog and change it to doc
nicoddemus Jun 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/3611.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The description above the example for ``@pytest.mark.skipif`` now better matches the code.
4 changes: 2 additions & 2 deletions doc/en/skipping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ during import time.

If you wish to skip something conditionally then you can use ``skipif`` instead.
Here is an example of marking a test function to be skipped
when run on a Python3.6 interpreter::
when run on an interpreter earlier than Python3.6 ::

import sys
@pytest.mark.skipif(sys.version_info < (3,6),
Copy link
Contributor Author

@AdamEr8 AdamEr8 Jun 22, 2018

Choose a reason for hiding this comment

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

Maybe the reason "requires python3.6" should also change to "requires python3.6 or higher" to fully match the condition

Copy link
Member

@nicoddemus nicoddemus Jun 22, 2018

Choose a reason for hiding this comment

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

Agreed!

reason="requires python3.6")
reason="requires python3.6 or higher")
def test_function():
...

Expand Down