|
1 | | -# Query help style-guide |
| 1 | +# Query help style guide |
2 | 2 |
|
3 | 3 | ## Introduction |
4 | 4 |
|
5 | 5 | When you contribute a new query to Semmle/ql for inclusion in the standard queries, you should also write a query help file. This file provides detailed information about the purpose and use of the query, which is available to users in LGTM (for example [here](https://lgtm.com/rules/1506093386171/)) and on the query homepages: |
6 | 6 |
|
7 | | -* [C/C++ queries](https://wiki.semmle.com/pages/viewpage.action?pageId=19334052) |
8 | | -* [C# queries](https://wiki.semmle.com/display/CSHARP/C%23+queries) |
9 | | -* [COBOL queries](https://wiki.semmle.com/display/COBOL/COBOL+queries) |
10 | | -* [Java queries](https://wiki.semmle.com/display/JAVA/Java+queries) |
11 | | -* [JavaScript queries](https://wiki.semmle.com/display/JS/JavaScript+queries) |
12 | | -* [Python queries](https://wiki.semmle.com/display/PYTHON/Python+queries) |
| 7 | +* [C/C++ queries](https://help.semmle.com/wiki/display/CCPPOBJ/) |
| 8 | +* [C# queries](https://help.semmle.com/wiki/display/CSHARP/) |
| 9 | +* [Java queries](https://help.semmle.com/wiki/display/JAVA/) |
| 10 | +* [JavaScript queries](https://help.semmle.com/wiki/display/JS/) |
| 11 | +* [Python queries](https://help.semmle.com/wiki/display/PYTHON/) |
13 | 12 |
|
14 | 13 | ### Location and file name |
15 | 14 |
|
@@ -37,7 +36,7 @@ Section-level elements are used to group the information within the query help f |
37 | 36 | 3. `example`—an example of code showing the problem. Where possible, this section should also include a solution to the issue. |
38 | 37 | 4. `references`—relevant references, such as authoritative sources on language semantics and best practice. |
39 | 38 |
|
40 | | -For further information about the other section-level, block, list and table elements supported by the qhelp format, see [Qhelp files](https://wiki.semmle.com/display/SD/Qhelp+files). |
| 39 | +For further information about the other section-level, block, list and table elements supported by the qhelp format, see [Qhelp files](https://help.semmle.com/wiki/display/SD/Qhelp+files). |
41 | 40 |
|
42 | 41 |
|
43 | 42 | ## English style |
|
0 commit comments