Skip to content

Fix typos, grammar errors, and missing/duplicated words in prose - #1307

Merged
myronmarston merged 1 commit into
mainfrom
myron/audit-prose-typos
Jul 14, 2026
Merged

Fix typos, grammar errors, and missing/duplicated words in prose#1307
myronmarston merged 1 commit into
mainfrom
myron/audit-prose-typos

Conversation

@myronmarston

Copy link
Copy Markdown
Collaborator

Summary

Most prose in this repo (docs, comments, error messages, test descriptions) was hand-written before LLM tooling existed, leaving scattered small mistakes throughout. This audits and fixes them across the whole codebase:

  • Markdown docs (READMEs, config/site guides/website content, CONTRIBUTING.md, CODEBASE_OVERVIEW.md, etc.)
  • Ruby/Python/shell comments and string literals (error messages, log messages, doc comments)
  • RSpec describe/it/context description strings

Fixes are limited to clear errors — misspellings, missing/duplicated words, subject-verb agreement, wrong word forms (e.g. "definitition" → "definition", "This file is contains" → "This file contains", "a Errors::ConfigError" → "an Errors::ConfigError"). No code logic or identifiers were changed.

Test plan

  • script/lint — 871 files inspected, no offenses
  • script/spellcheck (codespell) — clean
  • ruby -c on all 160 changed Ruby files — all pass
  • script/quick_build — 100% YARD doc coverage, all site links/pages valid, 147 build-suite tests pass, 0 failures

@myronmarston
myronmarston force-pushed the myron/audit-prose-typos branch 2 times, most recently from 323bcb4 to 8136354 Compare July 14, 2026 01:15
Most prose (docs, comments, error messages, test descriptions) was
hand-written before LLM tooling existed, leaving scattered small
mistakes across the monorepo. Audited markdown docs, Ruby/Python/shell
comments and string literals, and RSpec descriptions across all gems,
the docs website, scripts, and supporting tooling; fixed clear errors
(misspellings, missing/duplicated words, subject-verb agreement,
wrong word forms) without changing code logic or identifiers.

Generated with Claude Code
@myronmarston
myronmarston merged commit 594f61e into main Jul 14, 2026
27 checks passed
@myronmarston
myronmarston deleted the myron/audit-prose-typos branch July 14, 2026 17:48
jwils added a commit that referenced this pull request Jul 15, 2026
* origin-https/joshuaw/casing-support:
  Extract shared casing helpers
  index_data.painless script cleanup (#1308)
  Fix typos, grammar errors, and missing/duplicated words in prose (#1307)
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