docs: fix typos in documentation and code comments #1898
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BioGeek
requested review from
fegin,
tianyu-l,
wconstab and
wwwjn
as code owners
meta-cla
bot
added
the
CLA Signed
fegin
approved these changes
Oct 16, 2025
tianyu-l
pushed a commit
that referenced
this pull request
Oct 16, 2025
This PR adds a [`codespell`](https://github.com/codespell-project/codespell) pre-commit hook (see PRs #1583 / #1611 / #1898). With this PR, if you run `pre-commit run --all-files` on the current state of the repo, you will see: ``` trim trailing whitespace.................................................Passed check python ast.........................................................Passed check for merge conflicts................................................Passed don't commit to branch...................................................Passed check for added large files..............................................Passed fix end of files.........................................................Passed Insert license in comments...............................................Passed flake8...................................................................Passed Format files with µfmt...................................................Passed pydoclint................................................................Passed codespell................................................................Failed - hook id: codespell - exit code: 65 torchtitan/models/utils.py:51: caculate ==> calculate torchtitan/models/utils.py:71: Calulate ==> Calculate torchtitan/models/utils.py:71: dimesion ==> dimension torchtitan/models/utils.py:71: demension ==> dimension torchtitan/models/utils.py:76: divded ==> divided torchtitan/experiments/vlm/job_config.py:28: avaliable ==> available torchtitan/experiments/vlm/README.md:37: patchs ==> patches, paths torchtitan/experiments/vlm/README.md:40: indicies ==> indices torchtitan/components/quantization/__init__.py:28: re-usable ==> reusable torchtitan/models/qwen3/model/state_dict_adapter.py:144: compatibile ==> compatible torchtitan/models/attention.py:185: argumens ==> arguments torchtitan/components/metrics.py:322: emtpy ==> empty docs/torchft.md:60: sychronize ==> synchronize torchtitan/experiments/simple_fsdp/README.md:56: addtional ==> additional ``` After PR #1898 is merged, those warnings will disappear. Configuration for codespell is in `pyproject.toml`: ``` skip = ["*.json"] # <- json files are skipped due to too many false positives ignore-words-list = ["assertin", "datas" ,"indx", "inpt", "nd", "socio-economic"] # <- words that are ignored because they are used as variables etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to PRs #1583 / #1611
Fixes a few typos found by running
codespellon the repository.Also see related PR #1899 which adds a
codespellpre-commit hook.