Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos discovered by codespell #132

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Fix typos discovered by codespell #132

merged 1 commit into from
Aug 29, 2024

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Aug 29, 2024

https://pypi.org/project/codespell

% codespell --ignore-words-list=gameboy,ist,mata,nd,openend,theses --quiet=3 --skip="./archive/*,*.html,*.js"

./README.md:19: commited ==> committed
./posts/2022/12/pypy-v7311-release.txt:18: incoporates ==> incorporates
./posts/2024/03/fixing-bug-incremental-gc.md:327: manged ==> managed
./posts/2024/05/vmprof-firefox.md:29: re-use ==> reuse
./posts/2024/07/mining-jit-traces-missing-optimizations-z3.md:25: combinatorical ==> combinatorial
./posts/2024/07/toy-abstract-interpretation.md:34: abtract ==> abstract
./posts/2024/08/toy-knownbits.md:296: knownledge ==> knowledge
./posts/2024/08/toy-knownbits.md:732: abitrary ==> arbitrary
./posts/2024/08/toy-knownbits.md:1496: informations ==> information
./posts/2023/12/pypy-moved-to-git-github.md:105: sucessfully ==> successfully
./posts/2023/12/pypy-moved-to-git-github.md:107: transfered ==> transferred
./posts/2023/12/pypy-moved-to-git-github.md:131: developement ==> development
./posts/2023/12/pypy-v7314-release.txt:17: Hightlights ==> Highlights
./posts/2021/04/some-uses-of-graphviz.txt:103: milage ==> mileage
./posts/2021/05/pypy-v735-release.rst:20: releae ==> release
./posts/2021/10/pypy-v737-release.rst:29: conncurrent ==> concurrent
./pages/download_advanced.rst:94: Platfoms ==> Platforms
./pages/download_advanced.rst:249: tpyical ==> typical
./pages/people.rst:120: developement ==> development
./pages/pypy-sponsors.md:14: encoutered ==> encountered

% codespell --ignore-words-list=gameboy,ist,mata,nd,openend,theses --quiet=3 --skip="./archive/*,*.html,*.js --write-changes"

Removing *.html from --skip would show approx 140 more typos.

@mattip
Copy link
Member

mattip commented Aug 29, 2024

Thanks! Skipping the HTML makes sense, no need to fix all the historical documentation.

It might be nice to add this to the Makefile either here or in a future PR. I think we would want something like

  • add codespell to the virtualenv build command
  • add a .PHONY codespell step and (optionally) change the build step to depend on that step and to fail if there are typos
  • add an appropriate config file, and use --config in the codespell invocation (rather than the magical .codespellrc or setup.cfg so that future me will understand where the config values are

Note the Makefile uses a non-standard > prefix so I don't have to change my editor's tab/spaces replacement policy.

@mattip mattip merged commit b2d79a6 into pypy:main Aug 29, 2024
5 checks passed
@cclauss cclauss deleted the codespell branch August 29, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants