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

Lint documentation #228

Open
BarthPaleologue opened this issue Dec 19, 2024 · 0 comments
Open

Lint documentation #228

BarthPaleologue opened this issue Dec 19, 2024 · 0 comments
Labels

Comments

@BarthPaleologue
Copy link
Owner

Install and use eslint-plugin-jsdoc to lint the project's documentation and emit warnings when issues are identified. (use typescript's recommended linting options)

Additionally, use https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#readme to emit warnings when typescript interfaces are not documented.

Also disable auto-fixing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant