Skip to content

Fix spell check false positives by ignoring words #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2024
Merged

Fix spell check false positives by ignoring words #42

merged 1 commit into from
May 28, 2024

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 28, 2024

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 false misspelled word detections:

https://github.com/arduino-libraries/Arduino_BMI270_BMM150/actions/runs/9265690392

spellcheck: src/BMI270.cpp#L8
InterruptIn ==> interrupting, interrupt in, interruption
spellcheck: src/BMI270.cpp#L30
InterruptIn ==> interrupting, interrupt in, interruption

Since the code that produced the detections is correct and intended, the false positives are resolved by configuring codespell to ignore the problematic word.

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 false misspelled word
detections.

Since the code that produced the detections is correct and intended, the false positives are resolved by configuring
codespell to ignore the problematic word.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: infrastructure Related to project infrastructure labels May 28, 2024
@per1234 per1234 self-assigned this May 28, 2024
@per1234 per1234 merged commit f9c013e into arduino-libraries:master May 28, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant