Update JSDoc usage & fix minor JSDoc spelling typos #2638
Conversation
This file contains 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
This provides a better developer experience with highlighted links
scottdixon
approved these changes
Nov 11, 2024
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?
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
@seeJSDoc tag. https://jsdoc.app/tags-seeWHAT 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.
After
Example of JSDoc using the
@seeHOW 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