Skip to content

Add codespell support with configuration and fixes - #23

Merged
candytaco merged 6 commits into
mainfrom
worktree-introduce-codespell
May 29, 2026
Merged

Add codespell support with configuration and fixes#23
candytaco merged 6 commits into
mainfrom
worktree-introduce-codespell

Conversation

@mvdoc

@mvdoc mvdoc commented May 29, 2026

Copy link
Copy Markdown
Contributor

Add codespell configuration and fix existing typos.

More about codespell: https://github.com/codespell-project/codespell

CI workflow has permissions set to read only so it's safe.

Changes

Configuration & Infrastructure

  • Added .codespellrc with skip patterns for binaries (*.pdf, *.svg, *.png, *.ico, *.db), CSS, minified files, lock files, build outputs (bin, obj, packages), and *.DotSettings.
  • Added .github/workflows/codespell.yml to run codespell on push and PRs targeting main.

Typo Fixes

Ambiguous typos fixed manually (5 fixes with context review):

  • interallyinternally in 4 files (SharpEyes/Models/Calibrator.cs, SharpEyes/Models/RBF2D.cs, Eyetracking/Calibrator.cs, Eyetracking/RBF2D.cs). Comment "they're interally contained" describes encapsulation of NumSharp structures, so "internally" not "integrally".
  • matchinematching in Eyetracking/Templates.cs. XML doc <returns>best matchine digit</returns> refers to the best-matching digit, not "best machine digit".

Non-ambiguous typos fixed automatically via datalad run 'codespell -w' (8 fixes across 8 files):

  • doesen'tdoesn't in SharpEyes/SharpEyes.csproj and CrashReporter/CrashReporter.csproj
  • IndentifiedIdentified in two CalibrationParameters.cs files
  • tgethe in Eyetracking/MainWindow.CalibrationTab.cs
  • lableslabels in Eyetracking/MainWindow.xaml.cs
  • Pre-selectPreselect in SharpEyes/ViewModels/PythonSettingsViewModel.cs
  • assumsassumes in docs/workflow/stimulus and gaze.md

All edits are in comments, XML docstrings, or prose — no code identifiers, regex patterns, string literals, or behavior affected.

Testing

Codespell passes with zero errors after all fixes.


Generated with Claude Code.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a .codespellrc configuration file and fixes various typos in comments and documentation across multiple files, including corrections for 'doesn't', 'identified', 'internally', 'the', 'labels', 'matching', 'preselect', and 'assumes'. There are no review comments to address, and I have no further feedback to provide.

mvdoc and others added 5 commits May 29, 2026 14:39
Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 <noreply@anthropic.com>
Fixed ambiguous typos:
- interally -> internally (SharpEyes/Models/Calibrator.cs, SharpEyes/Models/RBF2D.cs, Eyetracking/Calibrator.cs, Eyetracking/RBF2D.cs)
  Comment "they're interally contained" describes encapsulation, i.e. internal use.
- matchine -> matching (Eyetracking/Templates.cs)
  XML doc "<returns>best matchine digit</returns>" refers to the best-matching digit.

Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 <noreply@anthropic.com>
Fixed typos:
- doesen't -> doesn't (SharpEyes/SharpEyes.csproj, CrashReporter/CrashReporter.csproj)
- Pre-select -> Preselect (SharpEyes/ViewModels/PythonSettingsViewModel.cs)
- Indentified -> Identified (SharpEyes/Models/CalibrationParameters.cs, Eyetracking/CalibrationParameters.cs)
- tge -> the (Eyetracking/MainWindow.CalibrationTab.cs)
- lables -> labels (Eyetracking/MainWindow.xaml.cs)
- assums -> assumes (docs/workflow/stimulus and gaze.md)

Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 <noreply@anthropic.com>

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Fixed contextually unambiguous typos introduced in new origin/main content:
- frams -> frames (README.md: recentered frames)
- fiter -> filter (README.md: filter responses)
- Becuase -> Because (README.md)
- buil -> build (README.md: build from source)
- exectuable -> executable (docs/building.md)

Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 <noreply@anthropic.com>
@mvdoc
mvdoc force-pushed the worktree-introduce-codespell branch from 476c52e to 67741d3 Compare May 29, 2026 22:34
@candytaco
candytaco self-requested a review May 29, 2026 23:31
# Conflicts:
#	Eyetracking/CalibrationParameters.cs
#	Eyetracking/Calibrator.cs
#	Eyetracking/MainWindow.CalibrationTab.cs
#	Eyetracking/MainWindow.xaml.cs
#	Eyetracking/RBF2D.cs
#	Eyetracking/Templates.cs
@candytaco
candytaco merged commit 2359987 into main May 29, 2026
1 check failed
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