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

Fix some TSDoc/JSDoc lint issues #2181

Merged
merged 2 commits into from Apr 7, 2024

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Apr 6, 2024

Pull Request

Problem

Trying lint with eslint-plugin-jsdoc shows lots of warnings.

Solution

Fix the warnings other than:

  • prefer @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:

  • preferred types, like object rather than Object
  • missing @return on function
  • @package tag does not allow trailing comment

Not 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.

@shadowspawn shadowspawn merged commit b95ea44 into tj:develop Apr 7, 2024
8 checks passed
@shadowspawn shadowspawn deleted the feature/jsdoc-tidy branch April 7, 2024 00:40
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pending release Merged into a branch for a future release, but not released yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants