From 024e58850347ab5d530256b5fc1f2c0d4573c3ec Mon Sep 17 00:00:00 2001 From: james Date: Tue, 22 Sep 2020 14:15:18 +0100 Subject: [PATCH 1/2] mention new cli command --- docs/language/learn-ql/writing-queries/query-help.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/language/learn-ql/writing-queries/query-help.rst b/docs/language/learn-ql/writing-queries/query-help.rst index df33c64ffdc..9d844844821 100644 --- a/docs/language/learn-ql/writing-queries/query-help.rst +++ b/docs/language/learn-ql/writing-queries/query-help.rst @@ -21,7 +21,7 @@ For more information about how to write useful query help in a style that is con 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 `__." Structure ========= From c2d4a670c93380b75214fda4003fc2c2dfb35ccf Mon Sep 17 00:00:00 2001 From: james Date: Tue, 22 Sep 2020 14:23:44 +0100 Subject: [PATCH 2/2] mention new cli command in query help style guide --- docs/query-help-style-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/query-help-style-guide.md b/docs/query-help-style-guide.md index f8584cb5e98..c5456d6717c 100644 --- a/docs/query-help-style-guide.md +++ b/docs/query-help-style-guide.md @@ -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 `__." + ### 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.