diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index 0493d1e4985..8b8b8dabf47 100644 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -219,13 +219,16 @@ alerts generated by the custom queries. From CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files by providing the ``--sarif-add-query-help`` option when running ``codeql database analyze``. +For more information, see `Configuring CodeQL CLI in your CI system ` +in the GitHub documentation. -You can write query help for custom queries directly in markdown file and save it alongside the +You can write query help for custom queries directly in a markdown file and save it alongside the corresponding query. Alternatively, for consistency with the standard CodeQL queries, -you can write query help in the ``.qhelp`` format and convert it to markdown before -running the analysis. Query help written in ``.qhelp`` files can't be included in SARIF files, -and they can't be processed by code scanning. For more information, see -":doc:`Testing query help files `." +you can write query help in the ``.qhelp`` format. Query help written in ``.qhelp`` +files can't be included in SARIF files, and they can't be processed by code +scanning so must be converted to markdown before running +the analysis. For more information, see ":doc:`Query help files `" +and ":doc:`Testing query help files `." Results -------