Skip to content

Commit 6ca8653

Browse files
jf205felicitymay
andauthored
Apply suggestions from code review
Co-Authored-By: Felicity Chapman <[email protected]>
1 parent ff599a5 commit 6ca8653

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/query-help-style-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Query help files must have the same base name as the query they describe and mus
1616

1717
### File structure and layout
1818

19-
Query files are written using a custom XML format, and stored in a file with a `.qhelp` extension. The basic structure is as follows:
19+
Query help files are written using a custom XML format, and stored in a file with a `.qhelp` extension. The basic structure is as follows:
2020

2121
```
2222
<!DOCTYPE qhelp SYSTEM "qhelp.dtd">
@@ -107,7 +107,7 @@ For example:
107107
108108
### Referencing potential security weaknesses
109109

110-
If your query checks code for a CWE weakness, you should use the `@tags` element in the query file to reference the associated CWEs, as explained [here](query-metadata-style-guide.md). When you use these tags, a link to the appropriate entry from the [MITRE.org](https://cwe.mitre.org/scoring/index.html) site will automatically appear as a reference in the query help file.
110+
If your query checks code for a CWE weakness, you should use the `@tags` element in the query file to reference the associated CWEs, as explained [here](query-metadata-style-guide.md). When you use these tags, a link to the appropriate entry from the [MITRE.org](https://cwe.mitre.org/scoring/index.html) site will automatically appear as a reference in the output HTML file.
111111

112112
## Query help example
113113

@@ -179,4 +179,4 @@ tab width settings cannot be taken into account.
179179
180180
</references>
181181
</qhelp>
182-
```
182+
```

0 commit comments

Comments
 (0)