[INFRA] Add "codespell" tool to CI checks to catch typos sooner

[DimitriPapadopoulos]

New typos found by latest version of codespell.

A couple other style issues.

[Remi-Gau]

LGTM

Personal note: learn how to spell "dictionary"

[sappelhoff]

Thanks @DimitriPapadopoulos I have two comments:

You have touched some files without content changes, like this one (screenshot):

What's that about?

Secondly, do you think it'd make sense to integrate codespell into our CI (if possible)?

[DimitriPapadopoulos]

Ah, you're right. I ran chmod -x on that file because it should not be executable (does not start #!). See the comments in the different commits.

I am trying to integrate codespell in the CI process of different projects, but I'm not there yet.

[DimitriPapadopoulos]

Actually, I'm already there for GitHub, but not for GitLab.

I have added codespell to GitHub CI. The problem is with some residual false-positives:

./tools/schemacode/schema.py:40: fo ==> of, for
./tools/schemacode/schema.py:41: fo ==> of, for
./src/01-introduction.md:119: TE ==> THE, BE, WE, TO
./src/99-appendices/08-coordinate-systems.md:110: ALS ==> ALSO
./src/99-appendices/08-coordinate-systems.md:112: ALS ==> ALSO
./src/99-appendices/08-coordinate-systems.md:113: ALS ==> ALSO
./src/99-appendices/08-coordinate-systems.md:133: ALS ==> ALSO
./src/99-appendices/08-coordinate-systems.md:137: ALS ==> ALSO
./src/schema/metadata/EchoTime.yaml:4: TE ==> THE, BE, WE, TO
./pdf_build_src/process_markdowns.py:443: fo ==> of, for
./pdf_build_src/process_markdowns.py:444: fo ==> of, for
./pdf_build_src/process_markdowns.py:467: fo ==> of, for
./pdf_build_src/process_markdowns.py:468: fo ==> of, for

I'm not certain what the best strategy is. Accept all these small variables names as valid, and perhaps skip future actual errors?

[sappelhoff]

Cool!

Accept all these small variables names as valid, and perhaps skip future actual errors?

I'd say that's an improvement over the status quo 👍

[DimitriPapadopoulos]

Done.

[DimitriPapadopoulos]

I hope I have got the on: part right

[sappelhoff]

Great, thanks a lot @DimitriPapadopoulos