Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
        rp2:    +0 +0.000% PICO

Codecov Report

Merging #10911 (867e4dd) into master (07a719a) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##           master   #10911   +/-   ##
=======================================
  Coverage   98.49%   98.49%           
=======================================
  Files         155      155           
  Lines       20583    20583           
=======================================
  Hits        20273    20273           
  Misses        310      310           

It also has lots of false positives...

Unless there's an easy way to make it ignore those (something like a rule making it discard all uppercase things, plus lists of things to ignore like 'ure') it seems more like an annoyance.

Unless there's an easy way to make it ignore those

Yes there are lots of options. Like --ignore-regex and the ability to skip files.

OK, with some simple exclusions I've reduced the number of reported spelling mistakes down from 850 to 380. And most of these are spelling mistakes that should be corrected.

Yeah that looks good. Well, apart from the spelling errors themselves :)

I think it would help if contributors run a check with the same rules before committing.
therefore I would suggest using a config file, there are a few different formats supported, the .codespell.rc can be in the repo root, or in the tools folder if specified
That way it can be included in a pre-commit hook or into an IDE.
Also I think a few more folder exclusions make sense to make this more usable on a dev setup rather than only in CI ( .git,.*_cache,**/build* )
.codespell.rc

[codespell]
skip = ./drivers/cc3100,./ports/cc3200/hal,./lib,.git,.*_cache,**/build*
count =
quiet-level = 3
ignore-words-list = iput,ans,ure,extint 
ignore-regex = '\b[A-Z]{3}\b'

One feature that I miss in codespell is to allow an override / ignore in code
with cspell I can use # spell-checker: disable to override a suggestion, in a specific line / file without needing to add it to a dictionary.

one example is
ports\stm32\usbhost\Class\AUDIO\Src\usbh_audio.c:942: OT ==> TO, OF, OR, NOT

that is just a comment, and can easily be rewritten.
In other cases that will neet to require an addition to the wordlist.

As a last comment, as a non-native-speaker:
Please make it explicit which flavor/flavour of English should be used for the documentation. Im OK with UK , and US , but now I'm wondering if I need to update my internal AU dictionaries as well 🦘

Thanks for the feedback.

I've now make a config file tools/codespell.cfg with the relevant configuration. And the ci_code_spell_run function in tools/ci.sh can be used (eg at the CLI) to run codespell.

I've also only included certain directories at the moment in the spell check, to make it easier to pass CI. I excluded the ports/ directory. We can add that later with spelling fixed (when someone has time to do it).

I also fixed about 64 spelling mistakes in those directories that are included in the code spell CI.

As a last comment, as a non-native-speaker:
Please make it explicit which flavor/flavour of English should be used for the documentation. Im OK with UK , and US , but now I'm wondering if I need to update my internal AU dictionaries as well kangaroo

In AU we usually use UK spelling 😄

I think codespell allows both US and UK spelling, and we can leave it at that (although I prefer UK).

I've now make a config file tools/codespell.cfg with the relevant configuration

This probably won't help IDE auto-detection of the config, which would expect to find .codespellrc (hopefully this would be configurable but it would be good to make it work out-of-the-box which is I think what @Josverl was suggesting).

This probably won't help IDE auto-detection of the config, which would expect to find .codespellrc

Maybe we will go with pyproject.toml, per #10977.

@Josverl does pyproject.toml work for you?

That should work. I can test tomorrow. Need to find a decent add= with proper support for the tool ide platform combo

I've moved the config to pyproject.toml in the root directory of this repo. It's now possible to simply run codespell in the root of the repo to check the spelling (ie no arguments needed).

The config in pyproject.toml is picked up by all tools I have tried with IDE integration in VSCode and Pycharm.
In most cases there are options to provide overrides in IDE settings.
tested:

• black
• codespell - included in Trunk
• pylance/pyright
• ruff

Great, thanks for confirming pyproject.toml works!