docs(slop): straighten em dashes in layout and RichTextEditor doc prose - #4698
Merged
Conversation
An anti-pattern list item used an em dash to introduce a qualification. Replace it with a colon. Found during Night Watch doc review.
…ices Two bestPractices descriptions used em dashes: one to introduce the new-tab link mechanism, one before an appositive about getExtendedIcon. Replace with a colon and a semicolon respectively. Found during Night Watch doc review.
josephfarina
requested review from
cixzhang,
ejhammond and
imdreamrunner
as code owners
August 4, 2026 09:25
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 Modified ComponentsRichTextEditor (@astryxdesign/lab) · View in Storybook
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
Straighten three em dashes in doc prose per the AI-slop rubric (check 17, sub A1). Prose only; meaning preserved; no code, labels, or CJK punctuation touched.
packages/cli/assets/docs/layout.doc.dense.mjs: an anti-pattern list item used an em dash to introduce a qualification. Now a colon.packages/lab/src/RichTextEditor/RichTextEditor.doc.mjs: two bestPractices descriptions used em dashes, one to introduce the new-tab link mechanism (now a colon) and one before an appositive about getExtendedIcon (now a semicolon).Icon.doc.mjs had a fourth em dash in the same category; it is already handled in #4676, so it is not touched here.
RichTextEditor.doc.mjsis also edited by #4380, but that PR adds atabEscapeHintprop entry in the props array, a region disjoint from these bestPractices edits, so the two do not conflict.Checklist
pnpm --filter @astryxdesign/core typecheck:docspassestsc --project packages/cli/tsconfig.template-docs.json --noEmitpassesdocOverlays.test.mjspasses (reference dense overlay unaffected)astryx docs layout --lang denserenders the colon correctlyNight Watch — Doc Reviewer