docs: replace em dashes in theme and Selector block doc prose - #5251
Open
josephfarina wants to merge 1 commit into
Open
docs: replace em dashes in theme and Selector block doc prose#5251josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
theme.doc.mjs: recast three em-dash asides in the Quick Start, inheritance, and font-loading sections as parentheses (appositive) and a sentence break. SelectorOptionDescriptions.doc.mjs: replace the em dash before 'both on the 4px rhythm' with a semicolon. Prose only; no meaning changed. Found during Night Watch doc review. Night Watch — Doc Reviewer
|
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 SummaryNo component packages changed. 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
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
Four em-dash prose tells replaced with the right punctuation (AI-slop check 17, sub A1). Prose only; no meaning changed.
packages/cli/assets/docs/theme.doc.mjs(three): the Quick Start map aside and the inheritance base-error aside become parentheses (appositives); the font-loading line's em-dash clause becomes a sentence break.packages/cli/assets/templates/blocks/components/Selector/SelectorOptionDescriptions.doc.mjs(one): the em dash beforeboth on the 4px rhythmbecomes a semicolon (two independent clauses).Validation
pnpm --filter @astryxdesign/core typecheck:docspassestsc --project packages/cli/tsconfig.template-docs.json --noEmit: only the pre-existingtheme.template.ts:83TS2307 (untouched by this change)astryx docs themerenders the rewritten prose correctlyimport()Merge-checked against the four other open PRs touching
theme.doc.mjs(#5204, #5115, #5099, #4930): no conflict on either changed file.Night Watch — Doc Reviewer