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

Automatically generate missing options sections in rule docs #237

Closed
bmish opened this issue Nov 18, 2022 · 0 comments · Fixed by #481
Closed

Automatically generate missing options sections in rule docs #237

bmish opened this issue Nov 18, 2022 · 0 comments · Fixed by #481
Labels
enhancement New feature or request
Milestone

Comments

@bmish
Copy link
Owner

bmish commented Nov 18, 2022

Mentioned here: #236 (comment)

If a rule with options is missing an options section in its doc, we could try to generate a barebones options section with the list of options we can detect from the schema. It would still require manual attention to fill in the explanation/details for each option.

Details about options that would be useful to generate/include:

Potentially could be used in ESLint core: eslint/eslint#16643 (comment)

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

Successfully merging a pull request may close this issue.

1 participant