Shopify / hydrogen

Hydrogen lets you build faster headless storefronts in less time, on Shopify.
https://hydrogen.shop
MIT License
1.45k stars 280 forks source link

Update JSDoc usage & fix minor JSDoc spelling typos #2638

Closed lb- closed 3 days ago

lb- commented 3 weeks ago

WHY are these changes introduced?

While exploring the code for the first time, I found that some small typos exist and it would be good to have these cleaned up.

In addition, there were some candidates for converting plain comments to JSDoc style comments and leveraging the @see JSDoc tag. https://jsdoc.app/tags-see

WHAT is this pull request doing?

Before

Example of JSDoc when the tag is not used, the link appears in line and is harder to parse visually.

Screenshot 2024-11-07 at 11 51 42 AM

After

Example of JSDoc using the @see Screenshot 2024-11-07 at 11 51 54 AM

HOW to test your changes?

Review the code and double check that the JSDoc is formatted correctly for a few items in your preferred IDE.

Checklist