Skip to content
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

Add documentation blurb for --strict #3558

Merged
merged 3 commits into from
Jun 9, 2018

Conversation

nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Jun 9, 2018

Also remove Mark api from mark.rst: Feels out of place in there, plus the reference documentation already contains the reference API to all mark-related classes.

Fix #3549

Feels out of place in there, plus the reference documentation
already contains the reference API to all mark-related classes
@nicoddemus nicoddemus requested a review from blueyed June 9, 2018 15:03
Copy link
Member

@asottile asottile left a comment

Choose a reason for hiding this comment

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

little tiny changes :) otherwise looks good

doc/en/mark.rst Outdated
Raising errors on unknown marks: --strict
-----------------------------------------

The ``--strict`` command-line flag can be used to raise errors when marks not registered in the ``pytest.ini`` file.
Copy link
Member

Choose a reason for hiding this comment

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

how about

When the ``--strict`` command-line flag is passed, any marks not registered in the ``pytest.ini`` file will trigger an error.

or I guess, a one-word fix to the current phrasing would be to s/when marks not/when marks are not/

Copy link
Member Author

Choose a reason for hiding this comment

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

I like yours better, thanks!

doc/en/mark.rst Outdated
slow
serial

This can be used to prevent users mistyping mark names by accident. Test suites that want to enforce that this
Copy link
Member

Choose a reason for hiding this comment

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

s/that //

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops thanks

@coveralls
Copy link

coveralls commented Jun 9, 2018

Coverage Status

Coverage increased (+0.05%) to 92.752% when pulling c4f72e4 on nicoddemus:doc-strict into 55bbd3e on pytest-dev:master.

Copy link
Contributor

@blueyed blueyed left a comment

Choose a reason for hiding this comment

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

@nicoddemus
Copy link
Member Author

Great, thanks!

@blueyed next time feel free to merge it yourself. 😁

@nicoddemus nicoddemus merged commit 7c8d072 into pytest-dev:master Jun 9, 2018
@nicoddemus nicoddemus deleted the doc-strict branch June 9, 2018 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants