Skip to content

Commit 6b1406f

Browse files
authored
Merge pull request github#3226 from jf205/update-query-help-style-guide
docs: clarify 'query help' usage in 'Query help style guide'
2 parents b275987 + 6ca8653 commit 6b1406f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/query-help-style-guide.md

Lines changed: 7 additions & 7 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 an XML format called Qhelp, 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">
@@ -25,7 +25,7 @@ Query files are written using an XML format called Qhelp, and stored in a file w
2525
</qhelp>
2626
```
2727

28-
The header and single top-level `qhelp` element are both mandatory.
28+
The header and single top-level `<qhelp>` element are both mandatory.
2929

3030
### Section-level elements
3131

@@ -36,7 +36,7 @@ Section-level elements are used to group the information within the query help f
3636
3. `example`—an example of code showing the problem. Where possible, this section should also include a solution to the issue.
3737
4. `references`—relevant references, such as authoritative sources on language semantics and best practice.
3838

39-
For further information about the other section-level, block, list and table elements supported by the qhelp format, see the [Query help reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-help.html) on help.semmle.com.
39+
For further information about the other section-level, block, list and table elements supported by query help files, see the [Query help reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-help.html) on help.semmle.com.
4040

4141

4242
## English style
@@ -86,7 +86,7 @@ For example:
8686

8787
>W. C. Wake, _Refactoring Workbook_, pp. 93 – 94, Addison-Wesley Professional, 2004.
8888
89-
Note, & symbols need to be replaced by \&amp;. The symbol will be displayed correctly in the html files generated from the qhelp files.
89+
Note, & symbols need to be replaced by \&amp;. The symbol will be displayed correctly in the HTML files generated from the query help files.
9090

9191
### Academic papers
9292

@@ -107,11 +107,11 @@ 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 qhelp 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

114-
The following example is a qhelp file for a query from the standard query suite for Java:
114+
The following example is a query help file for a query from the standard query suite for Java:
115115

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

0 commit comments

Comments
 (0)