New doc role: globalvar for special variables #7474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces a new role, `:globalvar:`, so we can mark/reference variables like `pytest_plugins`, `pytestmark`, etc. This besides being useful also makes the documentation look more consistent.
nicoddemus
commented
Jul 10, 2020
| @@ -280,37 +280,26 @@ its test methods: | |||
| This is equivalent to directly applying the decorator to the | |||
| two test functions. | |||
|
|
|||
| Due to legacy reasons, it is possible to set the ``pytestmark`` attribute on a TestClass like this: | |||
There was a problem hiding this comment.
Moved this legacy note to the bottom, the text reads better this way.
nicoddemus
commented
Jul 10, 2020
| @@ -971,12 +968,6 @@ test functions and methods. Can be either a single mark or a list of marks. | |||
|
|
|||
| pytestmark = [pytest.mark.integration, pytest.mark.slow] | |||
|
|
|||
| PYTEST_DONT_REWRITE (module docstring) | |||
There was a problem hiding this comment.
This is not really a global variable, and is already mentioned in detail in the assertion chapter, so decided to remove this from here as it is pretty niche.
nicoddemus
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces a new role,
:globalvar:, so we can mark/reference variables likepytest_plugins,pytestmark, etc. This besides being useful also makes the documentation look more consistent.Also uses proper references in the CHANGELOG for #7466 as commented in #7466 (comment).