[Lint] Prefer American English spelling #1022
Conversation
|
👋 Hi! Thank you for contributing to the TileLang project. Please remember to run We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀 |
WalkthroughAdds a case-insensitive file-contents sorter pre-commit hook targeting docs/spelling_wordlist.txt; introduces a spelling wordlist and codespell configuration; standardizes spelling in multiple docs and example files; updates minor strings/docstrings in BitNet examples; fixes a typo in tilelang overrides docstring. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant Git as Git
participant PC as pre-commit
participant Hooks as Hook Runner
participant Sorter as file-contents-sorter
participant Repo as Repo Files
Dev->>Git: git commit
Git->>PC: Invoke pre-commit
PC->>Hooks: Run configured hooks
Hooks->>Sorter: Execute on docs/spelling_wordlist.txt
Sorter->>Repo: Sort contents (ignore case)
Note over Sorter,Repo: Only targets docs/spelling_wordlist.txt
Hooks-->>PC: Hook results
PC-->>Git: Pass/fail
Git-->>Dev: Commit proceeds or is blocked
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
.pre-commit-config.yaml(1 hunks)README.md(1 hunks)docs/compiler_internals/inject_fence_proxy.md(1 hunks)docs/spelling_wordlist.txt(1 hunks)examples/bitnet-1.58b/modeling_bitnet.py(1 hunks)examples/bitnet-1.58b/tokenization_bitnet.py(2 hunks)examples/deepseek_mla/amd/README.md(2 hunks)examples/gdn/README.md(1 hunks)pyproject.toml(1 hunks)tilelang/language/overrides/__init__.py(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-test-metal
🔇 Additional comments (11)
examples/gdn/README.md (1)
13-15: Section title now matches US spelling.The header uses “Acknowledgments,” aligning with the American-English pass across docs.
examples/bitnet-1.58b/modeling_bitnet.py (1)
1721-1727: Docstring wording synchronized with US spelling.“Labeled span” reads consistently with the rest of the repo’s guidance.
docs/compiler_internals/inject_fence_proxy.md (1)
7-8: Terminology matches the new spelling rules.Switching to “undefined behavior” keeps this doc in step with the codespell dictionary.
README.md (1)
245-247: Top-level README header updated to US spelling.The rename to “Acknowledgments” keeps the branding consistent.
tilelang/language/overrides/__init__.py (1)
4-5: Docstring now reflects American English.Small wording tweak, no code impact—looks good.
docs/spelling_wordlist.txt (1)
2-8: LGTM!The remaining entries appear to be legitimate technical terms, acronyms, or identifiers that should be excluded from spell-checking (e.g., "hsa" for HSA architecture, "LOD" for Level of Detail, "NotIn" as a code identifier).
examples/deepseek_mla/amd/README.md (1)
50-52: LGTM!The change from "Acknowledgement" to "Acknowledgment" correctly standardizes to American English spelling.
.pre-commit-config.yaml (1)
31-33: LGTM!The
file-contents-sorterhook with--ignore-casecorrectly ensures the spelling wordlist remains consistently sorted.examples/bitnet-1.58b/tokenization_bitnet.py (2)
173-177: LGTM!Correctly updates "behaviour" to "behavior" (American English) in the legacy mode warning message.
218-218: LGTM!Correctly updates "behaviour" to "behavior" (American English) in the error message.
pyproject.toml (1)
84-85: LGTM!The codespell configuration correctly enables British-to-American English conversion via the
en-GB_to_en-USbuiltin dictionary and references the ignore-words file.
| @@ -0,0 +1,8 @@ | |||
| cancelled | |||
There was a problem hiding this comment.
🧩 Analysis chain
Verify the inclusion of "cancelled" in the ignore list.
The PR aims to standardize on American English spelling, yet "cancelled" (British spelling) is added to the ignore list instead of being changed to "canceled" (American spelling). Please verify whether "cancelled" appears in contexts that cannot be changed (e.g., external dependencies, quoted text, API names).
🏁 Script executed:
#!/bin/bash
# Description: Verify usage of "cancelled" and "canceled" in the codebase.
# Expected: Understand why "cancelled" is in the ignore list.
echo "=== Searching for 'cancelled' (British spelling) ==="
rg -n -C3 --type-add 'code:*.{py,md,rst,txt,yaml,toml}' --type code 'cancelled'
echo -e "\n=== Searching for 'canceled' (American spelling) ==="
rg -n -C3 --type-add 'code:*.{py,md,rst,txt,yaml,toml}' --type code 'canceled'Length of output: 244
Replace ‘cancelled’ with American ‘canceled’ in docs/spelling_wordlist.txt to align with the project’s American English standard.
🤖 Prompt for AI Agents
In docs/spelling_wordlist.txt around lines 1 to 1, the word "cancelled" uses
British spelling; replace it with the American spelling "canceled" (single L)
and save the file so the project’s American English spelling standard is
enforced.
2 participants
Add dictionary
en-GB_to_en-UStocodespell.Summary by CodeRabbit
Documentation
Style
Chores