Migrate/audit JSDoc on public APIs (APIs)#57383
Closed
huntie wants to merge 2 commits into
Closed
Conversation
Summary: I asked Claude to crawl reactnative.dev and insert JSDoc comments into our core components, based on some manual-pass starting points. This is also a quality pass on all modules touched, standardising JSDoc use, and in some cases merging/removing redundant information (preferring the docs we’ve maintained more carefully on the website). Commit 1 of 2 (Components). Replaces react#57380. Changelog: [Internal] Differential Revision: D110195869
Summary: I asked Claude to crawl reactnative.dev and insert JSDoc comments into our core components, based on some manual-pass starting points. This is also a quality pass on all modules touched, standardising JSDoc use, and in some cases merging/removing redundant information (preferring the docs we’ve maintained more carefully on the website). **Manual edits** - `StyleSheet` Commit 2 of 2 (APIs). Replaces react#57380. Changelog: [General][Added] - Strict TypeScript API: Component and API doc comment coverage has been significantly improved Differential Revision: D110195868
meta-cla
Bot
added
the
CLA Signed
|
@huntie has exported this pull request. If you are a Meta employee, you can view the originating Diff in D110195868. |
|
This pull request has been merged in 701de4e. |
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:
Context
Strict TypeScript API readiness: High quality inline docs should reach users via TypeScript in their IDEs.
This diff
I asked Claude to crawl reactnative.dev and insert JSDoc comments into our core components, based on some manual-pass starting points.
This is also a quality pass on all modules touched, standardising JSDoc use, and in some cases merging/removing redundant information (preferring the docs we’ve maintained more carefully on the website).
Manual edits
StyleSheetCommit 2 of 2 (APIs).
Replaces #57380.
Changelog:
[General][Added] - Strict TypeScript API: Component and API doc comment coverage has been significantly improved
Differential Revision: D110195868