mirror of
https://github.com/github/codeql.git
synced 2026-04-20 22:44:52 +02:00
Apply suggestions from code review
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
This commit is contained in:
@@ -30,7 +30,7 @@ source_suffix = {
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
# -- Project-specifc options for HTML output ----------------------------------------------
|
||||
# -- Project-specific options for HTML output ----------------------------------------------
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
@@ -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-*'] # ignore toc-<lang>.rst files as they are 'included' in index pages
|
||||
|
||||
@@ -3,6 +3,6 @@ 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>`__.
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL for Go repository <https://github.com/github/codeql-go/tree/main/ql/examples>`__.
|
||||
|
||||
.. include:: toc-go.rst
|
||||
.. include:: toc-go.rst
|
||||
|
||||
@@ -7,8 +7,8 @@ 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/gitub/codeql>`__
|
||||
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem to your code.
|
||||
- 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::
|
||||
:titlesonly:
|
||||
@@ -19,4 +19,4 @@ Each query help article includes:
|
||||
java
|
||||
javascript
|
||||
python
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user