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

Addons: Improve JSDocs #30106

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Conversation

s-rigaud
Copy link
Contributor

Description

Add missing parameter types to decrease eslint warnings. From 33 to 4.

@donmccurdy
Copy link
Collaborator

I'm fine with the changes, but, are we doing anything with JSDoc in these folders? Would we prefer to limit ESLint to the folders where JSDoc is run?

@s-rigaud
Copy link
Contributor Author

As eqeqeq eslint rule has been deactivated from the whole project because it was causing too many warnings in the addons folder while running the lint command, I think it might be great to keep the valid-jsdoc rule. The only issue with this rule is that currently some documentation in addons are treated as invalid JSdoc and so 30 warnings have been added in the linting command output. With this PR I just tried to remove all these warnings polluting the output, no addition to previous doc is wanted simply reducing the current doc treated by default as JSdoc due to the syntax 🤔

@Mugen87
Copy link
Collaborator

Mugen87 commented Dec 12, 2024

Okay, let's merge but let's also focus the JSDoc efforts on src/nodes for now.

@Mugen87 Mugen87 merged commit 346e21d into mrdoob:dev Dec 12, 2024
11 checks passed
@Mugen87 Mugen87 added this to the r172 milestone Dec 12, 2024
@s-rigaud s-rigaud deleted the addons-add-missing-jsdoc-params branch December 31, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants