Fix spellcheck false positive #6
Merged
Conversation
This file contains hidden or 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
This file defines Arduino's standardized configuration for the codespell spellchecker tool. The file will also allow project specific configuration of exclusions to fix false positives.
The codespell spellchecker tool is used to detect occurrences of commonly misspelled words in the project files. The project readme references the acronym "ALS" (ambient light sensor). This happens to be in the codespell misspelled word dictionary as a misspelling of "also", and so causes a failure of the spellcheck. The false positive is resolved by adding the word to the ignore list in the codespell configuration.
per1234
added
type: imperfection
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 detect occurrences of commonly misspelled words in the project files.
The project readme references the acronym "ALS" (ambient light sensor). This happens to be in the codespell misspelled
word dictionary as a misspelling of "also", and so causes a failure of the spellcheck.
The false positive is resolved by adding the word to the ignore list in the codespell configuration.