Skip to content

Commit 4cea019

Browse files
author
james
committed
add/improve intro text and add links to example queries
1 parent dcf52f3 commit 4cea019

File tree

8 files changed

+34
-5
lines changed

8 files changed

+34
-5
lines changed

‎docs/codeql/query-help/cpp.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
C and C++ query help
22
=====================
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/cpp/ql/examples>`__.
7+
48
.. include:: toc-cpp.rst
59

‎docs/codeql/query-help/csharp.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
C# query help
22
=============
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/csharp/ql/examples>`__.
7+
48
.. include:: toc-csharp.rst

‎docs/codeql/query-help/go.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
Go query help
22
=============
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql-go/tree/main/ql/examples>`__.
7+
48
.. include:: toc-go.rst

‎docs/codeql/query-help/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
CodeQL query help
22
-----------------
33

4-
Use the sidebar to view the query help for the queries included in the "code scanning" and "security extended" query suites for a single language.
4+
View the query help for the queries included in the ``code-scanning``, ``security-extended``, and ``security-and-quality`` query suites for the languages supported by CodeQL.
55

6-
Each query help page includes:
6+
Each query help article includes:
77

8-
- A summary of key metadata for the query
8+
- A summary of key metadata for the query.
9+
- Information about which query suites the query is included in.
910
- A link to the query in the `CodeQL repository <https://github.com/gitub/codeql>`__
10-
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem in your code
11+
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem to your code.
1112

1213
.. toctree::
1314
:titlesonly:
14-
:hidden:
1515

1616
cpp
1717
csharp

‎docs/codeql/query-help/java.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
Java query help
22
===============
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/java/ql/examples>`__.
7+
48
.. include:: toc-java.rst

‎docs/codeql/query-help/javascript.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
JavaScript query help
22
=====================
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/javascript/ql/examples>`__.
7+
48
.. include:: toc-javascript.rst

‎docs/codeql/query-help/python.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
Python query help
22
=================
33

4+
.. include:: ../reusables/query-help-overview.rst
5+
6+
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/python/ql/examples>`__.
7+
48
.. include:: toc-python.rst

‎docs/codeql/reusables/query-help-overview.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Visit the articles below to see the documentation for the queries included in the following query suites:
2+
3+
- ``code-scanning``: queries run by default in code scanning.
4+
- ``security-extended``: queries from ``code-scanning``, plus extra security queries with slightly lower precision and severity.
5+
- ``security-and-quality``: queries from ``code-scanning``, ``security-and-quality``, plus extra maintainability and reliability queries.

0 commit comments

Comments
 (0)