Skip to content

Fix spell check false positive by ignoring word #63

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

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 1, 2025

The codespell spellchecker tool is used to automatically detect commonly misspelled words in the files of this project.

One of the identifiers nextED used in the codebase happens to match against the misspelled word dictionary entry for "nested", which causes codespell to produce a false misspelled word detection:

https://github.com/arduino-libraries/Arduino_USBHostMbed5/actions/runs/15993572864/job/45111731078#step:4:17

Error: ./src/USBHost/USBEndpoint.cpp:43: nextED ==> nested, texted
Error: ./src/USBHost/USBEndpoint.cpp:164: nextED ==> nested, texted
Error: ./src/USBHost/USBHost.cpp:785: nextED ==> nested, texted
Error: ./src/USBHost/USBHostTypes.h:[19](https://github.com/arduino-libraries/Arduino_USBHostMbed5/actions/runs/15993572864/job/45111731078#step:4:20)2: nextED ==> nested, texted
Codespell found one or more problems

Since the code that produced the detection is correct and intended, the false positive is 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.

One of the identifiers "nextED" used in the codebase happens to match against the misspelled word dictionary entry for
"nested", which causes 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.
@per1234 per1234 self-assigned this Jul 1, 2025
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: infrastructure Related to project infrastructure labels Jul 1, 2025
@per1234 per1234 requested review from Copilot and removed request for Copilot July 1, 2025 08:45
Copilot

This comment was marked as spam.

@per1234 per1234 requested a review from a team July 1, 2025 08:56
Copy link
Contributor

@sebromero sebromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@per1234 per1234 merged commit 53c81d7 into arduino-libraries:main Jul 1, 2025
3 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.

2 participants