-
Notifications
You must be signed in to change notification settings - Fork 562
feat(eslint-config-fluid): Promote jsdoc/require-description rule from "recommended" to "minimal"
#26189
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
base: main
Are you sure you want to change the base?
feat(eslint-config-fluid): Promote jsdoc/require-description rule from "recommended" to "minimal"
#26189
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
tylerbutler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One problem with this is that the server release group uses minimal. So if we make changes to that config, it implies server work that may not be accounted for. I recommend keeping minimal as it is and moving packages to recommended instead.
The other minor issue is that changes to the old configs will need to be manually moved into the new eslint9-native config that's in progress.
Part of an ongoing effort to collapse
recommendedintominimal-deprecatedso we can remove the "minimal" config variant.The description component of the API docs is the most important, and should always be present (for anything documented). This is what appears first in intellisense and what appears top-level views in our published API docs.
Also leverages Claude Code to fill in missing documentation per our docs guidelines. I audited these changes and reverted anything that seemed questionable. Feedback from area owners on how to fix / improve these docs is appreciated :)