Skip to content
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

Enforce proper documentation of core components #30

Closed
quentinderoubaix opened this issue Jul 28, 2023 · 0 comments · Fixed by #52
Closed

Enforce proper documentation of core components #30

quentinderoubaix opened this issue Jul 28, 2023 · 0 comments · Fixed by #52
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@quentinderoubaix
Copy link
Contributor

Is your feature request related to a problem? Please describe.
There is no automatic check that helps developers write api documentation of their core component.

Describe the solution you'd like
Use eslint plugin https://github.com/gajus/eslint-plugin-jsdoc with some smart configuration to enforce proper api documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant