github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-07-16 14:42:29 -05:00
Code Issues 276 Packages Projects Releases 26 Wiki Activity

[GH-ISSUE #1532] fix(ci): codespell flags valid technical terms -- add .codespellrc ignore list #16313

New Issue
Closed
opened 2026-05-24 10:33:19 -05:00 by GiteaMirror · 1 comment
GiteaMirror commented 2026-05-24 10:33:19 -05:00
Owner
Copy Link

Originally created by @Shashank-Tripathi-07 on GitHub (Apr 25, 2026).
Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/1532

Problem

The Check for spelling errors CI check has been failing on every PR because codespell has no ignore list configured. It flags legitimate technical terms used throughout the codebase as misspellings:

Flagged word Actual meaning Location
Clos Clos network topology (standard datacenter term) slides/vol2/03_network_fabrics/
FPR False Positive Rate (ML metrics term) slides/vol1/15_responsible_engr/, slides/vol2/16_responsible_ai/
Rin Variable name for ring buffer / ring allreduce README.md
Curren Contributor name "Curren Iyer" README.md
finalY jsPDF Y-coordinate variable socratiq/src_shadow/js/
foundIn camelCase variable name socratiq/src_shadow/js/
ans Short variable name socratiq/src_shadow/js/
extit LaTeX \textit truncated in source slides/
targetin camelCase variable socratiq/src_shadow/js/

Fix

Add a .codespellrc at the repo root:

[codespell]
skip = ./.git,./node_modules,./socratiq/src_shadow
ignore-words-list = clos,fpr,rin,ans,fo

The socratiq/src_shadow/ directory contains vendored/compiled JS and should be skipped entirely. The remaining false positives (Clos, FPR, Rin, ans) are genuine domain terms that should be whitelisted.

Impact

This check has been failing on every merged PR (e.g. #1527, #1526, #1525) without blocking merges, meaning it provides no signal. Adding the ignore list will make the check meaningful again.

Originally created by @Shashank-Tripathi-07 on GitHub (Apr 25, 2026). Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/1532 ## Problem The `Check for spelling errors` CI check has been failing on every PR because `codespell` has no ignore list configured. It flags legitimate technical terms used throughout the codebase as misspellings: | Flagged word | Actual meaning | Location | |---|---|---| | `Clos` | Clos network topology (standard datacenter term) | `slides/vol2/03_network_fabrics/` | | `FPR` | False Positive Rate (ML metrics term) | `slides/vol1/15_responsible_engr/`, `slides/vol2/16_responsible_ai/` | | `Rin` | Variable name for ring buffer / ring allreduce | `README.md` | | `Curren` | Contributor name "Curren Iyer" | `README.md` | | `finalY` | jsPDF Y-coordinate variable | `socratiq/src_shadow/js/` | | `foundIn` | camelCase variable name | `socratiq/src_shadow/js/` | | `ans` | Short variable name | `socratiq/src_shadow/js/` | | `extit` | LaTeX `\textit` truncated in source | `slides/` | | `targetin` | camelCase variable | `socratiq/src_shadow/js/` | ## Fix Add a `.codespellrc` at the repo root: ```ini [codespell] skip = ./.git,./node_modules,./socratiq/src_shadow ignore-words-list = clos,fpr,rin,ans,fo ``` The `socratiq/src_shadow/` directory contains vendored/compiled JS and should be skipped entirely. The remaining false positives (`Clos`, `FPR`, `Rin`, `ans`) are genuine domain terms that should be whitelisted. ## Impact This check has been failing on every merged PR (e.g. #1527, #1526, #1525) without blocking merges, meaning it provides no signal. Adding the ignore list will make the check meaningful again.
GiteaMirror added the javascripttype: bugarea: socratiq labels 2026-05-24 10:33:19 -05:00
GiteaMirror commented 2026-05-24 10:33:26 -05:00
Author
Owner
Copy Link

@profvjreddi commented on GitHub (Apr 25, 2026):

Awesome, thanks @Shashank-Tripathi-07 - yea definitely need to fix it. I was going to make a full sweeping pass on it later today.

<!-- gh-comment-id:4319652977 --> @profvjreddi commented on GitHub (Apr 25, 2026): Awesome, thanks @Shashank-Tripathi-07 - yea definitely need to fix it. I was going to make a full sweeping pass on it later today.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area: book
area: collabs
area: kits
area: labs
area: socratiq
area: staffml
area: tinytorch
area: tools
area: website
bug
dependencies
format: epub
format: pdf
javascript
link-health
link-rot
priority-high
pull-request
Mirrored from GitHub Pull Request
 staffml
type: bug
type: citation
type: code
type: errata
type: improvement
type: new
type: question
vault-sli
No Label area: socratiq javascript type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#16313
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?