Jsdoc update #8266
Merged
Jsdoc update #8266
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laemtl
force-pushed
the
jsdoc-update
branch
3 times, most recently
from
93d0ac3
to
ed1d064
Compare
maltheism
approved these changes
Dec 14, 2022
maltheism
added
the
Passed Manual Tests
|
What does this do? |
|
what do you mean "enforced to follow the jsdoc rules"? |
maltheism
reviewed
Dec 16, 2022
| @@ -2,11 +2,25 @@ | |||
| "parser": "@babel/eslint-parser", | |||
| "plugins": [ | |||
| "react", | |||
| "no-jquery" | |||
| "no-jquery", | |||
| "jsdoc" | |||
There was a problem hiding this comment.
@driusan jsdoc has been added to the plugins. When "valid-jsdoc": "off" is set to "error" then we will get errors when running npm run compile such as if comments are missing @return or correct @param value. Also the comments now have a standardized structure requirement similar to php. I believe @laemtl has the rule currently set to off because she's cleaning up the comments in parts by separate PRs.
There was a problem hiding this comment.
Oups I forgot to add a description. Thanks @maltheism for the clarifications!
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
No description provided.