Skip to content

Conversation

@laemtl
Copy link
Contributor

@laemtl laemtl commented Dec 13, 2022

No description provided.

@laemtl laemtl force-pushed the jsdoc-update branch 3 times, most recently from 93d0ac3 to ed1d064 Compare December 14, 2022 04:42
@maltheism maltheism added the Passed manual tests PR has been successfully tested by at least one peer label Dec 14, 2022
@driusan
Copy link
Collaborator

driusan commented Dec 16, 2022

What does this do?

@maltheism
Copy link
Member

Hi @driusan the comments on the frontend are being enforced to follow the jsdoc rules. @laemtl had this in another PR and separated it to this PR because of rebasing.

@driusan
Copy link
Collaborator

driusan commented Dec 16, 2022

what do you mean "enforced to follow the jsdoc rules"?

"react",
"no-jquery"
"no-jquery",
"jsdoc"
Copy link
Member

@maltheism maltheism Dec 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups I forgot to add a description. Thanks @maltheism for the clarifications!

@driusan driusan merged commit da8dd5f into aces:main Dec 16, 2022
@ridz1208 ridz1208 added this to the 25.0.0 milestone Mar 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Passed manual tests PR has been successfully tested by at least one peer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants