Add rule doc notice type for rule description #350
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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.