arduino / ArduinoCore-avr

The Official Arduino AVR core
https://www.arduino.cc
1.25k stars 1.06k forks source link

Fix spell check false positive by ignoring word #497

Closed per1234 closed 2 years ago

per1234 commented 2 years ago

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 clen as a misspelling, resulting in a failing spell check result:

https://github.com/arduino/ArduinoCore-avr/runs/7968491292?check_suite_focus=true#step:4:17

Error: ./cores/arduino/USBCore.h:158: clen ==> clean, clan
Codespell found one or more problems

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.