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

Add option to create missing rule docs #79

Closed
bmish opened this issue Oct 9, 2022 · 0 comments · Fixed by #240
Closed

Add option to create missing rule docs #79

bmish opened this issue Oct 9, 2022 · 0 comments · Fixed by #240
Labels
enhancement New feature or request

Comments

@bmish
Copy link
Owner

bmish commented Oct 9, 2022

--init-rule-docs to create any missing rule docs.

Fail if there are no rule docs to create so this option isn't left in place indefinitely.

This would only be useful for someone who hasn't created any docs for their rules yet. In that scenario, this would help save time in getting started with documentation.

The reason we need an explicit option for this (and we don't want to automatically create missing rule docs by default) is because the rule docs might live at a non-standard path and we just didn't detect them. If the plugin has a non-standard rule doc path, the user just needs to specify --path-rule-doc.

Follow-up to #78.

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