Skip to content

Commit 51c0287

Browse files
committed
address review comments
1 parent e8f1e6f commit 51c0287

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/codeql/writing-codeql-queries/about-codeql-queries.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,16 @@ Import statements
6969
Each query generally contains one or more ``import`` statements, which define the :ref:`libraries <library-modules>` or :ref:`modules <modules>` to import into the query. Libraries and modules provide a way of grouping together related :ref:`types <types>`, :ref:`predicates <predicates>`, and other modules. The contents of each library or module that you import can then be accessed by the query.
7070
Our `open source repository on GitHub <https://github.com/github/codeql>`__ contains the standard CodeQL libraries for each supported language.
7171

72-
When writing your own alert queries, you would typically import the standard library for the language of the project that you are querying, using ``import`` followed by a language:
73-
74-
- C/C++: ``cpp``
75-
- C#: ``csharp``
76-
- Go: ``go``
77-
- Java: ``java``
78-
- JavaScript/TypeScript: ``javascript``
79-
- Python: ``python``
80-
- Ruby: ``ruby``
72+
When writing your own alert queries, you would typically import the standard library for the language of the project that you are querying. For more information about importing the standard CodeQL libraries, see the CodeQL library guides:
73+
74+
- :ref:`CodeQL library guide for C and C++ <codeql-library-for-cpp>`
75+
- :ref:`CodeQL library guide for C# <codeql-library-for-csharp>`
76+
- :ref:`CodeQL library guide for Go <codeql-library-for-go>`
77+
- :ref:`CodeQL library guide for Java <codeql-library-for-java>`
78+
- :ref:`CodeQL library guide for JavaScript <codeql-library-for-javascript>`
79+
- :ref:`CodeQL library guide for Python <codeql-library-for-python>`
80+
- :ref:`CodeQL library guide for Ruby <codeql-library-for-ruby>`
81+
- :ref:`CodeQL library guide for TypeScript <codeql-library-for-typescript>`
8182

8283
There are also libraries containing commonly used predicates, types, and other modules associated with different analyses, including data flow, control flow, and taint-tracking. In order to calculate path graphs, path queries require you to import a data flow library into the query file. For more information, see ":doc:`Creating path queries <creating-path-queries>`."
8384

docs/codeql/writing-codeql-queries/creating-path-queries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This topic provides information on how to structure a path query file so you can
1818

1919
Note
2020

21-
The alerts generated by path queries are included in the results generated using the :ref:`CodeQL CLI <codeql-cli>`. You can also view the path explanations generated by your path query in the :ref:`CodeQL extension for VS Code <codeql-for-visual-studio-code>`.
21+
The alerts generated by path queries are included in the results generated using the :ref:`CodeQL CLI <codeql-cli>` and in `code scanning <https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details>`__. You can also view the path explanations generated by your path query in the :ref:`CodeQL extension for VS Code <codeql-for-visual-studio-code>`.
2222

2323

2424
To learn more about modeling data flow with CodeQL, see ":doc:`About data flow analysis <about-data-flow-analysis>`."

0 commit comments

Comments
 (0)