Remove redundant unit test docstring requirements #469
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.
Description
Previously,
D10*lint rules were only excluded on*_test.pyfiles, so package docstrings were required on__init__.pyfiles in test modules. There were also a lot of old test docstrings that just said what the name of the test function said again.I've removed all of this and updated the ruff configuration to reduce redundant docstrings. In general, the name of the test function should describe its purpose (so the output of pytest -vv is helpful), and any extra details can be included in additional comments as needed but no docstrings are required.
Fixes N/A
Type of Change
Testing
Tests pass.
Pull Request Checklist
Please confirm the PR meets the following requirements.
pre-commit(e.g., mypy, ruff, etc.).