Testing: Add rule to enforce existence of JSDoc #15193
Labels
[Tool] Docgen
/packages/docgen
[Type] Automated Testing
Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests.
[Type] Task
Issues or PRs that have been broken down into an individual action to take
Previously: #6341, #4506, #4245
To the extent reasonable, we should enforce that all functions and top-level symbols of a file have preceding JSDoc. The goal here is in making helping to make clear the purpose of a function, both to the original author and to future maintainers.
Implementation Notes:
require-jsdoc
.@wordpress/element
(React) component API, as the documentation would not be very useful for methods likerender
eslint-plugin-require-jsdoc-except
allows for exceptions by namerequire-jsdoc
, so may be subject to future deprecation removaleslint-plugin-require-jsdoc-except
eslint-disable-next-line
inline adjacent to each violation (automation may help), with a "Disable reason" clarifying that there is no legitimate reason for it to be disabled, and that it should be corrected at the earliest opportunity.The text was updated successfully, but these errors were encountered: