Repository navigation
Describe every documented prop - #225
Merged
Merged
Conversation
The docs site now generates its API reference tables from these sources with the TypeScript compiler, so any prop without a JSDoc comment renders an empty Description cell. Adds a description to every prop that lacked one. Descriptions were written from how each prop is actually consumed in the component body, not from its name. No `@default` tags were added — the generator reads defaults from the destructuring in each signature, so a second copy would only drift; the few exceptions are props whose default is applied outside the signature and so isn't otherwise visible. Comments only. The single-line type literals that changed shape did so because a per-property JSDoc block cannot sit on one line.
Every one of these components destructures `size = "md"`, but the JSDoc above the prop claimed `"sm"`. The generated API tables read the real destructured value, so the published docs were right — the comment was lying to anyone reading the source, and it had already misled the FAQ on the inputs page into stating both the wrong count and the wrong default. `input-file.tsx` keeps `@default "sm"`: that one genuinely is "sm".
deebov
force-pushed
the
docs/prop-descriptions
branch
from
October 9, 2026 14:04
5edc6a1 to
ad8833c
Compare
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.
Description
The docs site now generates its API reference tables from these sources with the TypeScript compiler, so any prop without a JSDoc comment shows an empty Description cell. This PR adds a description to every prop that lacked one.
@defaulttags were added. The generator reads defaults from the destructuring in each signature, so a second copy would only drift.@default "sm"on the input sizes (they all destructuresize = "md").input-file.tsxkeeps"sm", which is correct there.Targets
main: the changes are comments only, with no runtime or type changes, so existing installs and freshadds behave exactly as before.v9picks this up whenmainis next merged into it.Related
main)Type of change
Testing
oxfmt --check,oxlintandtsc --noEmitpass.🤖 Generated with Claude Code