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

mention new cli command in query help style guide

Browse Source
This commit is contained in:
james
2020-09-22 14:23:44 +01:00
parent 024e588503
commit c2d4a670c9
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -10,6 +10,8 @@ When you contribute a new [supported query](supported-queries.md) to this reposi
* [JavaScript queries](https://help.semmle.com/wiki/display/JS/)
* [Python queries](https://help.semmle.com/wiki/display/PYTHON/)
When writing query help, you can test the files to make sure they are valid and render a preview of the content in markdown using the CodeQL CLI. For more information, see "`Testing query help files <https://help.semmle.com/codeql/codeql-cli/procedures/testing-query-help-files.html>`__."
### Location and file name
Query help files must have the same base name as the query they describe and must be located in the same directory.