Skip to content

Commit 7236f3b

Browse files
committed
improve description of new option
1 parent af0f32f commit 7236f3b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ You can also specify:
6464
see `Configuring CodeQL CLI in your CI system <https://docs.github.com/en/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system>`__ in the GitHub documentation.
6565

6666
- ``--sarif-add-query-help``: (supported in version 2.7.1 onwards) adds any custom query help written
67-
in Markdown to SARIF (v2.1.0 or later) analysis results. Query help stored in ``.qhelp`` files must be
67+
in markdown to SARIF files (v2.1.0 or later) generated by the analysis. Query help stored in ``.qhelp`` files must be
6868
converted to ``.md`` before running the analysis. For further information,
69-
see ":doc:`Testing query help files <testing-query-help-files>`."
69+
see ":doc:`Including query help for custom CodeQL queries in SARIF files <testing-query-help-files>`."
7070

7171
- .. include:: ../reusables/threads-query-execution.rst
7272

@@ -218,8 +218,8 @@ in SARIF files generated during an analysis.
218218
For CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
219219
by providing the ``--sarif-add-query-help`` option when running
220220
``codeql database analyze``. Query help written in ``.qhelp`` files cannot be include in SARIF files,
221-
somust be converted to markdown before running the analysis. For more information, see
222-
":doc:`Testing query help files <testing-query-help-files>`."
221+
so must be converted to markdown before running the analysis. For more information, see
222+
":ref:`Testing query help files <testing-query-help-files>`."
223223

224224
Results
225225
-------

0 commit comments

Comments
 (0)