chore: bulk update all jsdoc and jsdoctypes #2114
Merged
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.
Does a bulk update on all JSDoc and JSDoc types. I've spent a lot of time looking at these since I was investigating a better way to approach exporting our types.
In many of my previous PRs, I'd be slowly amending some of the JSDocs anyway, but decided to do a bulk update now to normalize how we do JSDocs, which will reduce the noise in future PRs.
@param
and@returns
, rather than@type
. We use this version in some cases to document the function, and I personally prefer this syntax is it closer to what JSDoc intended rather than coupling too tightly the type checker.@type
on its own, use a single line.@typedef
directives at the top of the file under theimport
statements.@typedef
but never use it.plugins/_collections.js
, dropped the@see
directive, as in retrospect I think it doesn't make sense to point the implementation to where it was exported.plugins/applyTransforms.js
, deletes the two type aliases forPathData
andMatrix
as the types were being aliases to achieve what variables names already do.This makes no changes to the implementation.