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.
Pull Request
Problem
Trying lint with eslint-plugin-jsdoc shows lots of warnings.
Solution
Fix the warnings other than:
@returns
over@return
. Might change that in future, but only cosmetic and noisy (lots) so left out of this PR.@remarks
is generating a bogus unrecognised tag warning, as should be allowed in TypeScript (TSDoc)The fixed errors are things like:
object
rather thanObject
@return
on function@package
tag does not allow trailing commentNot ready to turn on eslint-plugin-jsdoc as there is not yet support for configuring
settings.jsdoc.*
in flat config (to hopefully fix@remarks
), and a problem with the TypeScript declaration in the package which breaks the TypeScript parse of the eslint config file.