hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-18 21:44:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

add/improve intro text and add links to example queries

Browse Source
This commit is contained in:
james
2020-11-27 12:26:42 +00:00
parent dcf52f3ee3
commit 4cea019cee
8 changed files with 34 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/codeql/query-help/cpp.rst
View File

@@ -1,5 +1,9 @@
C and C++ query help
=====================
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-cpp.rst

4
docs/codeql/query-help/csharp.rst
View File

@@ -1,4 +1,8 @@
C# query help
=============
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-csharp.rst

4
docs/codeql/query-help/go.rst
View File

@@ -1,4 +1,8 @@
Go query help
=============
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-go.rst

10
docs/codeql/query-help/index.rst
View File

@@ -1,17 +1,17 @@
CodeQL query help
-----------------
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.
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.
Each query help page includes:
Each query help article includes:
- A summary of key metadata for the query
- A summary of key metadata for the query.
- Information about which query suites the query is included in.
- A link to the query in the `CodeQL repository <https://github.com/gitub/codeql>`__
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem in your code
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem to your code.
.. toctree::
:titlesonly:
:hidden:
cpp
csharp

4
docs/codeql/query-help/java.rst
View File

@@ -1,4 +1,8 @@
Java query help
===============
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-java.rst

4
docs/codeql/query-help/javascript.rst
View File

@@ -1,4 +1,8 @@
JavaScript query help
=====================
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-javascript.rst

4
docs/codeql/query-help/python.rst
View File

@@ -1,4 +1,8 @@
Python query help
=================
.. include:: ../reusables/query-help-overview.rst
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>`__.
.. include:: toc-python.rst