Add docstrings to public fixtures #1135
Merged
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 PR adds short docstrings to quickly check available fixtures and is especially usefull for new pytest-django users.
I've noticed that some public fixtures don't have docstrings to give the ability to quickly check what this fixture does.
For example, the command
pytest --fixtures
shows builtin and custom fixtures with their short descriptions, but pytest-django doesn't provide them all:After docstrings update: