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 help content for rule configuration #594

Open
BernieWhite opened this issue Nov 26, 2020 · 0 comments
Open

Add help content for rule configuration #594

BernieWhite opened this issue Nov 26, 2020 · 0 comments
Labels
enhancement New feature or request feature: core Issues that affect the core engine

Comments

@BernieWhite
Copy link
Member

Rules can define and use configuration. The configuration options may be important for the correct execution of the rule.

Currently rules that use configuration can include notes to describe how the rule can be configured. Notes are not displayed in standard output, however adding a specific section Configuration into rule help may be helpful.

Once configuration is put into a separate section it can be included in output as an additional option.

@BernieWhite BernieWhite added the enhancement New feature or request label Nov 26, 2020
@BernieWhite BernieWhite added the feature: core Issues that affect the core engine label Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature: core Issues that affect the core engine
Projects
None yet
Development

No branches or pull requests

1 participant