arduino-libraries / USBHost

USB Host Library for Arduino
http://arduino.cc/
118 stars 94 forks source link

Adjust spell checker configuration to fix false positive #43

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

The codespell tool is used for automated detection of common misspellings in the files of this project.

A new release of codespell includes an expansion of its misspellings dictionary. One of the additions is "secur" as a misspelling of "secure". The word "secur" occurs in the library's codebase:

https://github.com/arduino-libraries/USBHost/actions/runs/6390269849/job/17343187744#step:4:17

Error: ./src/hidusagestr.h:474: Secur ==> Secure
Error: ./src/hidusagestr.h:539: Secur ==> Secure

Although it is not clear why the author of that code felt the need to shorten the words, the prevalence of such shortening clearly indicates it was done on purpose so this is a false positive.

The false positive is fixed by adding "secur" to the ignored words list in the codespell configuration file.