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 rule doc notice type for rule description #350

Merged
merged 1 commit into from Dec 16, 2022
Merged

Conversation

bmish
Copy link
Owner

@bmish bmish commented Dec 16, 2022

This is helpful so that one can use the rule name as the rule doc title and then ensure the rule description is included below the rule doc title as one of the notices.

# rule-name

Rule description. This is the new notice type.

<!-- end auto-generated rule header -->

...

It's possible at some point we might want to show this description in italics to differentiate it from the rest of the rule doc body, or allow the user to specify their own formatting function for it.

Helps with #347. In the future, we might make this notice a default notice type if we change the default rule doc title format to exclude the rule description.

Closes #192 because this provides a way to always include the rule description as a notice in the rule doc header.

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 this pull request may close these issues.

New option for including rule description elsewhere in rule doc
1 participant