Fix codespell not running on some files #10220
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.
Codespell was not running on some files.
The current command should check multiple directory levels, but it does not:
It was only checking
.rst
files that were one directory below the top-level directories (about
,community
,contributing
, etc). It was not checking direct children of the top-level directories, nor was it checking children that were more deeply nested within subdirectories. This means that the entireabout
section was not being checked at all, since all the pages there are direct children of top-level folders.This updated command is a crude way to check multiple levels. There should be a better way to do this, but for some reason that way is not just using a single
/**/
.One uncaught typo was found with the updated command.
If you want to test out this updated codespell command, or a better alternate, try putting a typo like "1nd" in one file in each folder nesting level, then run the command (either locally or in CI).