hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Address review comments

Browse Source
This commit is contained in:
Owen Mansel-Chan
2025-06-18 23:59:04 +01:00
parent 5c71e3a922
commit 5bc974afe4
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/query-help-style-guide.md
View File

@@ -24,13 +24,19 @@ Query help files can be written in either a custom XML format (with a `.qhelp` e
#### Markdown query help files
A Markdown query help file should use the following structure and section order:
A Markdown query help file should use the following structure and section order (note that the `Implementation notes` section is optional):
1. **Overview** (level 2 heading, `## Overview`)
2. **Recommendation** (level 2 heading, `## Recommendation`)
3. **Example** (level 2 heading, `## Example`)
4. **Implementation notes** (optional, level 2 heading, `## Implementation notes`)
5. **References** (level 2 heading, `## References`)
```
## Overview
## Recommendation
## Example
## Implementation notes
## References
```
Each section should be clearly marked with the appropriate heading. See the other Markdown files in this repository for examples.
@@ -147,6 +153,7 @@ More information on how to test your query help files can be found [within the d
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.
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`.
3. For custom queries and custom query packs, only the Markdown format is supported.
## Query help example