Fix spell check false positive by ignoring word #497
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
In the latest release of the codespell tool used for automated spell checking of the files of this project, the word "clen" was added to the codespell misspelled words dictionary as a misspelling of "clean". This caused a false detection of a struct member name `clen` as a misspelling, resulting in a failing spell check result. Since the occurrence of this name is correct and intended in this project, the false positive is resolved by configuring codespell to ignore the problematic word.
aentinger
approved these changes
Sep 5, 2022
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.
In the latest release of the codespell tool used for automated spell checking of the files of this project, the word "clen" was added to the codespell misspelled words dictionary as a misspelling of "clean" or "clan".
This caused a false detection of a struct member name
clenas a misspelling, resulting in a failing spell check result:https://github.com/arduino/ArduinoCore-avr/runs/7968491292?check_suite_focus=true#step:4:17
Since the occurrence of this name is correct and intended in this project, the false positive is resolved by configuring codespell to ignore the problematic word.