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

Merge pull request #4321 from jf205/sd-216-ql

Browse Source 
CodeQL docs: mention `generate query-help` CLI command
This commit is contained in:
James Fletcher
2020-09-29 06:40:44 +01:00
committed by GitHub
parent 83340e2a62 c2d4a670c9
commit 589a097197
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/language/learn-ql/writing-queries/query-help.rst
View File

@@ -21,7 +21,7 @@ For more information about how to write useful query help in a style that is con
Overview Overview
======== ========
Each query help file provides detailed information about the purpose and use of a query. When you write your own queries, we recommend that you also write query help files so that other users know what the queries do, and how they work. Each query help file provides detailed information about the purpose and use of a query. When you write your own queries, we recommend that you also write query help files so that other users know what the queries do, and how they work. 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>`__."
Structure Structure
========= =========

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/) * [JavaScript queries](https://help.semmle.com/wiki/display/JS/)
* [Python queries](https://help.semmle.com/wiki/display/PYTHON/) * [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 ### 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. Query help files must have the same base name as the query they describe and must be located in the same directory.