/ eslint Public
Chore: enable additional eslint-plugin-jsdoc rules #12336
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:
What changes did you make? (Give an overview)
Following up on #12332, this enables two more rules for consistency:
I set both to enforce "never" because that seemed like the more common style within the codebase, but I don't have any personal preferences as to which we pick. I do think it would be good if it was consistent, though, since I believe that would reduce overhead for contributors who don't have much experience with JSDoc.
I think it would also be nice to enable require-description, but there are 31 instances of missing descriptions and I wanted to move onto some more important things. Could it be worth making a detailed issue with links to the doc blocks missing description and put the
help wantedlabel on it?
Is there anything you'd like reviewers to focus on?
Do others agree that this is something we should do?