Skip to content

Commit 5bc974a

Browse files
committed
Address review comments
1 parent 5c71e3a commit 5bc974a

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/query-help-style-guide.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@ Query help files can be written in either a custom XML format (with a `.qhelp` e
2424

2525
#### Markdown query help files
2626

27-
A Markdown query help file should use the following structure and section order:
27+
A Markdown query help file should use the following structure and section order (note that the `Implementation notes` section is optional):
2828

29-
1. **Overview** (level 2 heading, `## Overview`)
30-
2. **Recommendation** (level 2 heading, `## Recommendation`)
31-
3. **Example** (level 2 heading, `## Example`)
32-
4. **Implementation notes** (optional, level 2 heading, `## Implementation notes`)
33-
5. **References** (level 2 heading, `## References`)
29+
```
30+
## Overview
31+
32+
## Recommendation
33+
34+
## Example
35+
36+
## Implementation notes
37+
38+
## References
39+
```
3440

3541
Each section should be clearly marked with the appropriate heading. See the other Markdown files in this repository for examples.
3642

@@ -147,6 +153,7 @@ More information on how to test your query help files can be found [within the d
147153

148154
1. The XML format allows for the contents of other files to be included in the output generated by processing the file, as mentioned in the section `Code examples`. This is not possible with the Markdown format.
149155
2. When using the XML format, references are added to the output HTML file based on CWE tags, as mentioned in the section `Referencing potential security weaknesses`.
156+
3. For custom queries and custom query packs, only the Markdown format is supported.
150157

151158
## Query help example
152159

0 commit comments

Comments
 (0)