Skip to content

Commit 523c7b4

Browse files
committed
Correct H-levels for Parameters
1 parent 2a4e7d4 commit 523c7b4

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

‎docs/rule-template-docs.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,12 @@ following articles.
4545
- [UseConsistentParameterSetName](Rules/UseConsistentParameterSetName.md)
4646
- [UseConstrainedLanguageMode](Rules/UseConstrainedLanguageMode.md)
4747

48-
When the rule is configurable, include `### Parameter` for each setting after `## Configure rule`.
49-
Use an H3 heading for each setting and document what it controls, accepted values, and its default
50-
value.
48+
When the rule is configurable, include `## Parameters` section after `## Configure rule`. Use an H3
49+
heading for each setting and document what it controls, accepted values, and its default value.
5150

52-
Include `## Suppression` after the `## Configure rule` section only when the rule needs specific
53-
suppression syntax or examples. Otherwise, link readers to the general _Suppressing rules_ guidance
54-
from **Configure rule**.
51+
After the `## Configure rule` and any parameter sections, include a `## Suppression` section only
52+
when the rule needs specific suppression syntax or examples. Otherwise, link readers to the general
53+
_Suppressing rules_ guidance from **Configure rule**.
5554

5655
In the `## Further reading` section, provide links to additional resources that help readers
5756
understand the rule, its context, or related topics.

0 commit comments

Comments
 (0)