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.
After
Example of JSDoc using the @see
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.
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-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
@see
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