bugfix: Stricter check for "tests" and "docs" directories in sp-repo-review #527
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.
Summary
The
sp-repo-review
checks for the existence of thetests
(PY005) anddocs
(PY004) directories are too lenient and often return false positives.Details
The existence of a file or directory in the repo that contains the word "docs" or "tests" will result in a pass for these tests.
For example, the existence of the
.readthedocs
file causes thePY004 Has docs folder
test to pass, simply because it contains the workdocs
. Similarly, an innocuously named file such asfastest.txt
would result in a false pass ofPY005 Has tests folder
.This PR modifies the
PY004
andPY005
checks to:tests
ordocs
, rather than testing if the filename contains that string.test
is no longer a match for PY005: should betests
as per Scientific Python: package-structure; this required an update to the internal tests.