-
-
Couldn't load subscription status.
- Fork 2.9k
doc: add "Use pytest's strict mode" to good practices #13852
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
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.
👌
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.
Yay, looks great overall!
doc/en/explanation/goodpractices.rst
Outdated
| See the :confval:`strict` for the options it enables and their effect. | ||
|
|
||
| If pytest adds new strictness options in the future, they will also be enabled by ``strict``. | ||
| Therefore, you should only use ``strict`` if you use a locked version of pytest, |
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.
| Therefore, you should only use ``strict`` if you use a locked version of pytest, | |
| Therefore, you should only use ``strict`` if you use a pinned version of pytest, |
maybe?
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.
I think both terms are used, so I went with "pinned/locked".
| .. _`strict mode`: | ||
|
|
||
| Using pytest's strict mode | ||
| -------------------------- |
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.
Should this maybe have a versionadded directive, and/or a quick blurb on how to achieve the same result with older pytest versions?
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.
Added the versionadded. I didn't add how to achieve in previous versions, hopefully can be understood by following the links.
b263229 to
d68eba9
Compare
|
Thanks for the reviews. I also sync'd the text in the reference/changelog/goodpractice. |
Maybe it can increase adoption.