arduino / ArduinoCore-API

Hardware independent layer of the Arduino cores defining the official API
https://www.arduino.cc/reference/en/
GNU Lesser General Public License v2.1
216 stars 120 forks source link

Fix spell check false positive by ignoring word #235

Closed per1234 closed 6 months ago

per1234 commented 6 months ago

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

https://github.com/arduino/ArduinoCore-API/actions/runs/9265748213

spellcheck: api/Common.h#L111 shiftIn ==> shifting, shift in

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