address docs review comments

This commit is contained in:
james
2020-12-01 14:19:12 +00:00
parent f7fe7c03b8
commit 65a048b65c
10 changed files with 31 additions and 20 deletions

View File

@@ -57,4 +57,4 @@ html_static_path = ['../_static']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['toc-*'] # ignore toc-<lang>.rst files as they are 'included' in index pages
exclude_patterns = ['toc-*', 'readme.md'] # ignore toc-<lang>.rst files as they are 'included' in index pages

View File

@@ -1,5 +1,5 @@
C and C++ query help
=====================
CodeQL query help for C and C++
===============================
.. include:: ../reusables/query-help-overview.rst

View File

@@ -1,5 +1,5 @@
C# query help
=============
CodeQL query help for C#
========================
.. include:: ../reusables/query-help-overview.rst

View File

@@ -1,5 +1,5 @@
Go query help
=============
CodeQL query help for Go
========================
.. include:: ../reusables/query-help-overview.rst

View File

@@ -3,16 +3,27 @@ CodeQL query help
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 article includes:
- :doc:`CodeQL query help for C and C++ <cpp>`
- :doc:`CodeQL query help for C# <csharp>`
- :doc:`CodeQL query help for Go <go>`
- :doc:`CodeQL query help for Java <java>`
- :doc:`CodeQL query help for JavaScript <javascript>`
- :doc:`CodeQL query help for Python <python>`
- 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/github/codeql>`__.
- A description of the potential vulnerability that the query identifies and a recommendation for how to avoid introducing the problem to your code.
.. pull-quote:: Information
Each query help article includes:
- 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/github/codeql>`__.
- A description of the potential vulnerability that the query identifies and a recommendation for how to avoid introducing the problem to your code.
.. toctree::
:hidden:
:titlesonly:
cpp
csharp
go

View File

@@ -1,5 +1,5 @@
Java query help
===============
CodeQL query help for Java query
================================
.. include:: ../reusables/query-help-overview.rst

View File

@@ -1,5 +1,5 @@
JavaScript query help
=====================
CodeQL query help for JavaScript
================================
.. include:: ../reusables/query-help-overview.rst

View File

@@ -1,5 +1,5 @@
Python query help
=================
CodeQL query help for Python
============================
.. include:: ../reusables/query-help-overview.rst