docs(table): remove JS comment from useTableSelection @example block#4324
Merged
Merged
Conversation
Storybook autodocs can misparse a // comment inside an @example code fence, rendering the rest of the block as raw text. Move the accessible names note into the JSDoc description above the example and keep the code block to a single expression. Found during Night Watch doc review.
josephfarina
requested review from
cixzhang,
ejhammond and
imdreamrunner
as code owners
July 25, 2026 09:15
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR Modified ComponentsTable · View in Storybook
Bundle Size Summary
Accessibility AuditStatus: 1 accessibility violation(s) found — 1 serious. Table - 1 issue(s)
Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
github-actions
Bot
deleted the
navi/docs/storybook-compat-usetableselection
branch
July 26, 2026 06:58
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
The
getRowLabelJSDoc onuseTableSelectionhad a//comment inside its@examplecode fence. Storybook's autodocs markdown parser can treat a//line as ending or corrupting the fence, which renders the remainder of the example as raw text rather than code.Moved the "accessible names" explanation into the JSDoc description above the
@exampletag and reduced the code block to the singlegetRowLabelexpression. No behavior or type change; JSDoc prose only.Validation
pnpm --filter @astryxdesign/core typecheck:docspasses@examplescan reports no blank lines, JS comments, or bare>in the blockNight Watch — Doc Reviewer