docs: replace em dashes in three doc prose descriptions - #5180
Open
josephfarina wants to merge 1 commit into
Open
docs: replace em dashes in three doc prose descriptions#5180josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
Recast em dashes with the appropriate punctuation in prose descriptions: - theme-build command: semicolon between two independent clauses - BottomSheet height prop: comma for the continuation aside - TextArea maxLength prop: colon introducing the clarifying definition Meaning unchanged; only typography normalized. Found during Night Watch doc review.
|
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 ComponentsBottomSheet (@astryxdesign/core) · View in Storybook
TextArea (@astryxdesign/core) · 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
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
Three prose
descriptionfields used an em dash where standard punctuation reads better. Recast each per the AI-slop rubric (check 17, A1), preserving meaning:packages/cli/clients/cli/commands/theme-build.doc.mjs: em dash between two independent clauses becomes a semicolon ("stopping at the first failure; an app with several themes does not need a shell loop").packages/core/src/BottomSheet/BottomSheet.doc.mjs: em dash before a continuation aside becomes a comma ("a shorter detent, resuming when they drag it back").packages/core/src/TextArea/TextArea.doc.mjs: em dash introducing a clarifying definition becomes a colon ("user-perceived characters: an emoji or flag sequence counts as one").Prose strings only. No wording, technical claims, or structure changed.
Checklist
pnpm --filter @astryxdesign/core typecheck:docspasses--props/--helpoutput verified for BottomSheet, TextArea, theme buildNight Watch — Doc Reviewer