docs: remove em-dashes from VisuallyHidden and useTreeFocus prose#3493
Open
josephfarina wants to merge 1 commit into
Open
docs: remove em-dashes from VisuallyHidden and useTreeFocus prose#3493josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
Recast em-dash asides as semicolons in usage and bestPractices prose across VisuallyHidden (docs, docsZh, docsDense copies) and useTreeFocus. Meaning unchanged; only punctuation normalized. Found during Night Watch doc review.
josephfarina
requested review from
cixzhang,
ejhammond,
imdreamrunner,
marie-lucas,
nynexman4464 and
thedjpetersen
as code owners
meta-cla
Bot
added
the
CLA Signed
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR No new or modified components detected. Bundle Size Summary
Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two
.doc.mjsfiles carried em-dashes in prose strings, which the AI-slop rubric (check 17, sub A1) flags. Recast each as a semicolon so the two independent clauses stay separate without an em-dash.VisuallyHidden.doc.mjs:usage.description("no styling props; the whole point...") and twobestPracticesdon't-entries, across all three exports (docs,docsZh,docsDense).useTreeFocus.doc.mjs: onebestPracticesdon't-entry ("...prefer useGridFocus; those traversals differ from a tree.").Meaning is unchanged; only punctuation was normalized.
name/displayNamelabels and CJK punctuation were left alone.Checklist
pnpm --filter @astryxdesign/core typecheck:docspassesnpx tsc --project packages/cli/tsconfig.template-docs.json --noEmitpasses(required))Night Watch — Doc Reviewer