Fix spell check false positive by ignoring word #235
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
The codespell spellchecker tool is used to automatically detect commonly misspelled words in the files of this project. The misspelled words dictionary was expanded in the latest release of codespell. Some of the text in the project codebase happens to match against newly added entries, which caused codespell to produce a false misspelled word detection. Since the code that produced the detection is correct and intended, the false positive is resolved by configuring codespell to ignore the problematic word.
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.
The codespell spellchecker tool is used to automatically detect commonly misspelled words in the files of this project.
The misspelled words dictionary was expanded in the latest release of codespell. Some of the text in the project codebase happens to match against newly added entries, which caused codespell to produce a false misspelled word detection:
https://github.com/arduino/ArduinoCore-API/actions/runs/9265748213
Since the code that produced the detection is correct and intended, the false positive is resolved by configuring codespell to ignore the problematic word.