Missing js doc comment descriptions for Hydrogen 2025-10 gen docs v1#3668
Open
laurelthorburn wants to merge 2 commits into2025-10from
Open
Missing js doc comment descriptions for Hydrogen 2025-10 gen docs v1#3668laurelthorburn wants to merge 2 commits into2025-10from
laurelthorburn wants to merge 2 commits into2025-10from
Conversation
Contributor
|
Oxygen deployed a preview of your
Learn more about Hydrogen's GitHub integration. |
Contributor
|
We detected some changes in |
andguy95
approved these changes
Apr 7, 2026
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
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.
WHY are these changes introduced?
Part of https://github.com/shop/issues-learn/issues/1460
Shopify-dev PR: https://github.com/shop/world/pull/547474
After merging the gen docs v1 migration, some JSDoc comments on types/interfaces/functions were missing or didn't match their corresponding
.doc.tsdefinition descriptions. This caused descriptions to not show up correctly in the generated docs UI.WHAT is this pull request doing?
Fixes JSDoc comments to match
.doc.tsdefinition descriptions acrosshydrogen-reactandhydrogenpackages:Description mismatches (JSDoc had wrong text):
ExternalVideoBasePropsinExternalVideo.tsx— was using the component description instead of the props descriptionShopifyCookiesinanalytics-types.ts— updated to match.doc.tsgetClientBrowserParametersinanalytics.ts— updated to match.doc.tsparseMetafieldinparse-metafield.ts— updated to match.doc.tsMissing JSDoc +
@publicDocstag (no JSDoc existed):AnalyticsEventNameinanalytics-constants.tsAnalyticsPageTypeinanalytics-constants.tsShopifySalesChannelinanalytics-constants.tsUseCartDocsinCartProvider.tsxHydrogenCartForDocsincreateCartHandler.tsMissing
@publicDocstag (JSDoc existed but tag was absent):ShopifyProviderPropsinShopifyProvider.tsxHOW to test your changes?
npm run buildto confirm no build errorsPost-merge steps
Checklist