Improve README API documentation consistency and cross-references#3994
Draft
Improve README API documentation consistency and cross-references#3994
Conversation
- Standardize **Default:** formatting and remove NoInfer<> from signatures - Add missing descriptions (onFill, PartialPosition, ColumnWidth) and (internal) markers - Reorganize Types section into logical groups: Column, Render Props, Events, Callbacks, Grid Control, Utility, Internal - Add bidirectional cross-references between props and types (forward refs and "See also" back-refs) - Fix type accuracy: RenderCheckboxProps optionality, CellRendererProps/RenderRowProps completeness Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add missing periods to aria-label and aria-labelledby descriptions - Add missing description for aria-description prop - Fix comma splice in rows prop description - Fix "css" → "CSS" capitalization - Fix missing articles in onCellClick description - Add colon after "change the onSortColumnsChange function to" - Remove unused SelectColumn import from sorting example - Fix "renderRow prop" → "renderers.renderRow" for consistency Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix "css" → "CSS" in Vite warning - Add missing article: "when a keydown event" - Fix comma splice in direction prop: "the grid, it" → "the grid. It" - Fix missing article: "whether the column is frozen" - Standardize "Triggered" → "Callback triggered" for onActivePositionChange Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove inconsistent trailing periods in Features list - Fix "The rows data" → "Row data" for natural phrasing - Add missing type imports (Column, SortColumn) in code examples - Format sortDirection values in inline code backticks - Add missing article "an" before "indeterminate state" - Standardize "See also" for ColSpanArgs to use dotted notation - Improve CalculatedColumn description wording - Standardize onCellKeyDown description to "Callback triggered" pattern Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Summary
**Default:**format, removedNoInfer<>from doc signatures, added missing periodsonFilldescription with example,PartialPositionandColumnWidthtype entries,(internal)markers on non-exported typesRenderCheckboxPropsfield optionality, added full interface forCellRendererProps, added missingsetActivePositiontoRenderRowPropsTest plan
src/types.ts🤖 Generated with Claude Code