Add codespell support with configuration and fixes#1815
Conversation
- lastest -> latest (docs/tips.md:9) - "Use the latest release version" - RUNING -> RUNNING (submitit/slurm/test_slurm.py:298) - test fixture SLURM state Co-Authored-By: Claude Code 2.1.104 / Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Code 2.1.104 / Claude Opus 4.6 <noreply@anthropic.com>
Fixed typos:
- detailled -> detailed (README.md)
- asynchroneously -> asynchronously (docs/checkpointing.md)
- exemple -> example (docs/examples.md)
- concurent -> concurrent (docs/examples.md)
- everytime -> every time (docs/mnist.py, submitit/core/core.py)
- catched -> caught (docs/structure.md)
- submited -> submitted (docs/tips.md)
- runnning -> running (integration/preemption.py, submitit/core/plugins.py)
- whith -> with (integration/preemption.py)
- genarally -> generally (submitit/helpers.py)
- submiting -> submitting (submitit/helpers.py, submitit/core/core.py)
- begginning -> beginning (submitit/core/core.py)
- informations -> information (submitit/core/core.py)
- Accesssing -> Accessing (submitit/core/core.py)
- asynchornously -> asynchronously (submitit/core/core.py)
- submision -> submission (submitit/core/core.py)
- overiden -> overridden (submitit/core/job_environment.py)
- uncomplete -> incomplete (submitit/core/utils.py)
- instanciate -> instantiate (submitit/core/utils.py)
- cammand -> command (submitit/core/utils.py)
- formated -> formatted (submitit/slurm/slurm.py)
- befure -> before (submitit/slurm/slurm.py)
- overwritting -> overwriting (submitit/slurm/slurm.py)
Co-Authored-By: Claude Code 2.1.104 / Claude Opus 4.6 <noreply@anthropic.com>
=== Do not change lines below ===
{
"chain": [],
"cmd": "uvx codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
|
Hi @yarikoptic! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
| 5610980|RUNNING | ||
| 5610980.ext+|RUNNING | ||
| 5610980.0|RUNING | ||
| 5610980.0|RUNNING |
There was a problem hiding this comment.
was it a typo here on purpose? I guess let's see if tests fail ;)
meta-cla
Bot
added
the
CLA Signed
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
1 participant
Add codespell configuration and fix existing typos.
More about codespell: https://github.com/codespell-project/codespell
I personally introduced it to over a hundred of projects already mostly with a positive feedback
(see the "improveit-dashboard").
CI workflow has 'permissions' set only to 'read' so also should be safe.
Changes
Configuration & Infrastructure
[tool.codespell]section topyproject.tomlwith skip patterns.github/workflows/codespell.yml) to check spelling on push to main and PRs.pre-commit-config.yamlTypo Fixes
Ambiguous typos fixed manually (2 fixes with context review):
lastest→latestin docs/tips.md — "Use the latest release version"RUNING→RUNNINGin submitit/slurm/test_slurm.py — test fixture SLURM stateNon-ambiguous typos fixed automatically via
codespell -w(27 fixes in 13 files):Common fixes include:
everytime→every time,asynchornously→asynchronously,submiting/submited/submision→submitting/submitted/submission,runnning→running,begginning→beginning,overiden→overridden,instanciate→instantiate,Accesssing→Accessing,informations→information,uncomplete→incomplete,cammand→command,formated→formatted,overwritting→overwriting,whith→with,befure→before,genarally→generally,detailled→detailed,concurent→concurrent,exemple→example,catched→caughtHistorical Context
This project has had 10 prior commits fixing typos manually, demonstrating the value
of automated spell-checking.
Testing
🤖 Generated with Claude Code and love to typos free code