Skip to content

Missing js doc comment descriptions for Hydrogen 2025-10 gen docs v1#3668

Open
laurelthorburn wants to merge 2 commits into2025-10from
hydrogen-2025-10
Open

Missing js doc comment descriptions for Hydrogen 2025-10 gen docs v1#3668
laurelthorburn wants to merge 2 commits into2025-10from
hydrogen-2025-10

Conversation

@laurelthorburn
Copy link
Copy Markdown

@laurelthorburn laurelthorburn commented Apr 7, 2026

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.ts definition 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.ts definition descriptions across hydrogen-react and hydrogen packages:

Description mismatches (JSDoc had wrong text):

  • ExternalVideoBaseProps in ExternalVideo.tsx — was using the component description instead of the props description
  • ShopifyCookies in analytics-types.ts — updated to match .doc.ts
  • getClientBrowserParameters in analytics.ts — updated to match .doc.ts
  • parseMetafield in parse-metafield.ts — updated to match .doc.ts

Missing JSDoc + @publicDocs tag (no JSDoc existed):

  • AnalyticsEventName in analytics-constants.ts
  • AnalyticsPageType in analytics-constants.ts
  • ShopifySalesChannel in analytics-constants.ts
  • UseCartDocs in CartProvider.tsx
  • HydrogenCartForDocs in createCartHandler.ts

Missing @publicDocs tag (JSDoc existed but tag was absent):

  • ShopifyProviderProps in ShopifyProvider.tsx

HOW to test your changes?

  1. Run npm run build to confirm no build errors
  2. Run docs generation and verify the descriptions now appear correctly in the generated docs output for the affected pages

Post-merge steps

Checklist

  • I've read the Contributing Guidelines
  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've added a changeset if this PR contains user-facing or functional changes. Test changes or internal-only config changes do not require a changeset.
  • I've added tests to cover my changes
  • I've added or updated the documentation

@laurelthorburn laurelthorburn requested a review from jgray7019 April 7, 2026 15:40
@shopify
Copy link
Copy Markdown
Contributor

shopify bot commented Apr 7, 2026

Oxygen deployed a preview of your hydrogen-2025-10 branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment April 7, 2026 5:58 PM

Learn more about Hydrogen's GitHub integration.

@laurelthorburn laurelthorburn changed the title Hydrogen 2025 10 Missing js doc comment descriptions for Hydrogen 2025-10 gen docs v1 Apr 7, 2026
@laurelthorburn laurelthorburn changed the base branch from main to 2025-10 April 7, 2026 15:42
@laurelthorburn laurelthorburn marked this pull request as ready for review April 7, 2026 15:42
@laurelthorburn laurelthorburn requested a review from a team as a code owner April 7, 2026 15:42
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset.
If the changes are user-facing and should cause a version bump, run npm run changeset add to track your changes and include them in the next release CHANGELOG.
If you are making simple updates to examples or documentation, you do not need to add a changeset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants