Improve generated API doc comments (match baseline) (#57380)#57380
Closed
huntie wants to merge 1 commit into
Closed
Improve generated API doc comments (match baseline) (#57380)#57380huntie wants to merge 1 commit into
huntie wants to merge 1 commit into
Conversation
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 D109316360. |
huntie
added a commit
to huntie/react-native
that referenced
this pull request
Jun 30, 2026
Summary: Pull Request resolved: react#57380 Surface documentation on hover for more APIs in the generated TypeScript types (`types_generated/`). **Changes** - Fix doc comments that were previously detached from the intended symbol (`Modal`, `Button`, `TextInput`, `ScrollView`, and others). - Migrate doc comments/extra detail present in the legacy hand-written `.d.ts` files but missing from Flow source. - (**Note**: The quality of these vary — but lift the equivalent current state into Flow land.) - Reformat malformed JSDoc comments across the codebase. Comments only — no code or type changes. Does not look to audit/improve doc comments beyond today's manual TS API baseline. Changelog: [Internal] Differential Revision: D109316360
meta-codesync
Bot
changed the title
huntie
force-pushed
the
export-D109316360
branch
from
a9cdfae to
2806cbf
Compare
Summary: Pull Request resolved: react#57380 Surface documentation on hover for more APIs in the generated TypeScript types (`types_generated/`). **Changes** - Fix doc comments that were previously detached from the intended symbol (`Modal`, `Button`, `TextInput`, `ScrollView`, and others). - Migrate doc comments/extra detail present in the legacy hand-written `.d.ts` files but missing from Flow source. - (**Note**: The quality of these vary — but lift the equivalent current state into Flow land.) - Reformat malformed JSDoc comments across the codebase. Comments only — no code or type changes. Does not look to audit/improve doc comments beyond today's manual TS API baseline. Changelog: [Internal] Differential Revision: D109316360
huntie
force-pushed
the
export-D109316360
branch
from
2806cbf to
940d648
Compare
This was referenced Jun 30, 2026
meta-codesync Bot
pushed a commit
that referenced
this pull request
Jun 30, 2026
Summary: Pull Request resolved: #57382 **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). Commit 1 of 2 (Components). Replaces #57380. Changelog: [Internal] ___ Differential Revision: D110195869 fbshipit-source-id: a60cded5a0c599810c80d174b7de085903cd6701
meta-codesync Bot
pushed a commit
that referenced
this pull request
Jun 30, 2026
Summary: Pull Request resolved: #57383 **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** - `StyleSheet` Commit 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 fbshipit-source-id: 7d8880352c934702671f89a403f334e30b1e749c
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:
Surface documentation on hover for more APIs in the generated TypeScript types (
types_generated/).Changes
Modal,Button,TextInput,ScrollView, and others)..d.tsfiles but missing from Flow source.Comments only — no code or type changes. Does not look to audit/improve doc comments beyond today's manual TS API baseline.
Changelog: [Internal]
Differential Revision: D109316360