Docs: Minor tweaks to VS Code docs (query history + viewing results) #6523
Conversation
There was a problem hiding this comment.
@shati-patel 👋🏻 - this LGTM 💖
I made a very minor suggestion (but feel free to ignore), and have a question about the order in which the different formats are listed (feel free to ignore too!)
docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst
Outdated
Show resolved
Hide resolved
|
|
||
| #. 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>`." | ||
| 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**. |
There was a problem hiding this comment.
Is there a logic in the order in which the formats are listed (Is it how they appear when you right-click a result?) or should we mention them alphabetically?
There was a problem hiding this comment.
Good question! I've roughly listed them in order of "usefulness" 😀 People are probably most likely to want CSV, then SARIF, and (rarely) DIL. I think this also corresponds to the UI, but it depends on what's available, given the format of the query.
…cts.rst Co-authored-by: mc <[email protected]>
|
Thank you for the review and the questions, @mchammer01! I took your suggestion, which dismissed the approval 🙃 |
I noticed a few areas where the docs were outdated:
I've also pulled this info about different views into a Note (in an attempt to declutter the actual steps), but other suggestions are welcome 😅
PS: This can ship any time. I noticed these changes because of recent PRs in this general area (github/vscode-codeql#930 and github/vscode-codeql#929), but the docs change is valid now already!