Skip to content

Commit 2a51abd

Browse files
authored
Merge pull request github#6523 from shati-patel/vscode-docs
Docs: Minor tweaks to VS Code docs (query history + viewing results)
2 parents 38477d7 + 1dc18c4 commit 2a51abd

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,14 @@ To remove queries from the Query History view, select all the queries you want t
129129
Viewing query results
130130
-----------------------
131131

132-
#. Click a query in the Query History view to display its results in the Results view. Alternatively, right-click the result to select a different view:
132+
#. Click a query in the Query History view to display its results in the Results view.
133133

134-
- To view the results in :ref:`SARIF format <sarif-output>`, right-click and select **View SARIF**.
135-
- To view the results in :ref:`DIL format <dil>`, right-click and select **View DIL**.
134+
.. pull-quote:: Note
136135

137-
#. Use the dropdown menu in the Results view to choose which results to display, and in what form to display them, such as a formatted alert message or a table of raw results. The available output forms are specified by the format of the query and the metadata. For more information, see ":ref:`CodeQL queries <codeql-queries>`."
136+
Depending on the query, you can also choose different views such as CSV, :ref:`SARIF <sarif-output>`, or :ref:`DIL format <dil>`. For example, to view the DIL format, right-click a result and select **View DIL**.
137+
The available output views are determined by the format and the metadata of the query. For more information, see ":ref:`CodeQL queries <codeql-queries>`."
138+
139+
#. Use the dropdown menu in the Results view to choose which results to display, and in what form to display them, such as a formatted alert message or a table of raw results.
138140

139141
#. To sort the results by the entries in a particular column, click the column header.
140142

docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,13 @@ Changing the labels of query history items
3737

3838
The query history **Format** setting controls how the extension lists queries in the query history. By default, each item has a label with the following format::
3939
40-
[%t] %q on %d - %s
41-
42-
- ``%t`` is the time the query was run
40+
%q on %d - %s, %r result count [%t]
41+
4342
- ``%q`` is the query name
4443
- ``%d`` is the database name
4544
- ``%s`` is a status string
45+
- ``%r`` is the number of results
46+
- ``%t`` is the time the query was run
4647

4748
To override the default label, you can specify a different format for the query history items.
4849

0 commit comments

Comments
 (0)