Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JSDoc usage & fix minor JSDoc spelling typos #2638

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

lb-
Copy link
Contributor

@lb- lb- commented Nov 7, 2024

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

  • 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 noteworthy changes (Question: Would this be done for a small change, happy to add)
  • I've added tests to cover my changes N/A
  • I've added or updated the documentation (auto-generated)

Copy link
Contributor

@scottdixon scottdixon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some great polish, thanks @lb- 🙏

Copy link
Contributor

@wizardlyhel wizardlyhel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the polish

@wizardlyhel wizardlyhel merged commit 1a4d4da into Shopify:main Nov 26, 2024
6 of 7 checks passed
@lb- lb- deleted the cleanup/jsdoc-typos-formatting branch November 27, 2024 10:21
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.

3 participants