Skip to content

chore: fix typos and grammar in comments and docs#2446

Merged
frankensteinke merged 2 commits into
developfrom
chore/fix-comment-and-doc-typos
Jun 23, 2026
Merged

chore: fix typos and grammar in comments and docs#2446
frankensteinke merged 2 commits into
developfrom
chore/fix-comment-and-doc-typos

Conversation

@frankensteinke

@frankensteinke frankensteinke commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Spelling and grammar cleanup across the repo, found via a codespell dictionary sweep plus an LLM review pass over user-facing docs prose. No behavior change, no shipped UI strings affected.

Code-comment / dev-doc typos (codespell)

File Fix
e2e/readme.md threshh​old → threshold
packages/styles/variables.css hypen → hyphen (comment)
packages/react/src/utils/polymorphicComponent.test.tsx polymoprhic → polymorphic (comment)
packages/react/src/components/Toast/utils.ts indicies → indices (comment)
packages/react/src/components/TwoColumnPanel/TwoColumnPanel.tsx collapsable → collapsible (comment)

Docs-prose spelling / grammar (LLM review)

File Fix
docs/pages/components/TooltipTabstop.mdx keyboard-acces​ible → keyboard-accessible
docs/pages/intro.mdx "add include cauldron's styles" → "include …"; "This can be using" → "This can be done using"
docs/pages/components/ImpactBadge.mdx "Badge component is designed" → "Badge component that is designed"

Verified clean / intentionally skipped

  • Component source (aria-labels, default labels, rendered strings): no errors found.
  • ActionList.figma.tsx "Opitional": preserved deliberately to match the Figma layer name (per existing comment).
  • Stylistic only, not changed: missing trailing periods in TextEllipsis.mdx / colors.mdx descriptions (description punctuation is inconsistent repo-wide).
  • False positives ignored: Deque (company), master (branch), Testing Library APIs (waitFor, focusIn), <thead>.

Doc example fixes (duplicate aria-current, "Animated Progres") are in #2445.

Dictionary-checked typo fixes (no behavior change):

- e2e/readme.md: threshhold -> threshold
- packages/styles/variables.css: hypen -> hyphen (comment)
- polymorphicComponent.test.tsx: polymoprhic -> polymorphic (comment)
- Toast/utils.ts: indicies -> indices (comment)
- TwoColumnPanel.tsx: collapsable -> collapsible (comment)
Found via an LLM review pass over docs/pages prose and prop descriptions:

- TooltipTabstop: keyboard-accesible -> keyboard-accessible
- intro: "add include cauldron's styles" -> "include cauldron's styles";
  "This can be using" -> "This can be done using"
- ImpactBadge: "Badge component is designed" -> "Badge component that is
  designed"
@frankensteinke frankensteinke changed the title chore: fix typos in code comments and docs chore: fix typos and grammar in comments and docs Jun 22, 2026
@aws-amplify-us-east-1

Copy link
Copy Markdown

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2446.d15792l1n26ww3.amplifyapp.com

@frankensteinke
frankensteinke marked this pull request as ready for review June 22, 2026 13:49
@frankensteinke
frankensteinke requested review from a team as code owners June 22, 2026 13:49
Copilot AI review requested due to automatic review settings June 22, 2026 13:49
@frankensteinke
frankensteinke enabled auto-merge (squash) June 22, 2026 13:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Repository-wide spelling/grammar cleanup in developer-facing comments and documentation frontmatter/prose, with no functional changes.

Changes:

  • Corrected typos in code comments across styles and React packages (e.g., “hyphen”, “polymorphic”, “indices”, “collapsible”).
  • Corrected wording/grammar in documentation pages and frontmatter descriptions.
  • Corrected an E2E docs typo (“threshold”) in Playwright screenshot guidance.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/styles/variables.css Fixes a typo in the CSS variable naming-convention comment.
packages/react/src/utils/polymorphicComponent.test.tsx Fixes a typo in a type-test explanatory comment.
packages/react/src/components/TwoColumnPanel/TwoColumnPanel.tsx Fixes a typo in an internal behavior comment.
packages/react/src/components/Toast/utils.ts Fixes a typo in a utility comment.
e2e/readme.md Fixes “threshold” typo in screenshot comparison guidance.
docs/pages/intro.mdx Improves grammar in setup instructions.
docs/pages/components/TooltipTabstop.mdx Fixes a typo in frontmatter description (“keyboard-accessible”).
docs/pages/components/ImpactBadge.mdx Adjusts frontmatter description grammar for clarity.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@frankensteinke
frankensteinke merged commit 9b0e62c into develop Jun 23, 2026
13 of 14 checks passed
@frankensteinke
frankensteinke deleted the chore/fix-comment-and-doc-typos branch June 23, 2026 14:02
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.

3 participants