Apply suggestions from code review

Co-authored-by: Shati Patel <[email protected]>

Author: jf205

docs/codeql/conf.py

@@ -110,4 +110,4 @@ def setup(sphinx):
 html_static_path = ['_static']
 
 exclude_patterns = ['vale*', '_static', '_templates', 'reusables', 'images', 'support', 'ql-training', 'query-help','_build', '*.py*', 'README.rst']
-##############################################################################
+##############################################################################

docs/codeql/query-help/conf.py

@@ -30,7 +30,7 @@
     '.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 @@
 # 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

docs/codeql/query-help/go.rst

@@ -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

docs/codeql/query-help/index.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
-   
+   

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

@@ -1,5 +1,5 @@
 Visit the articles below to see the documentation for the queries included in the following query suites:
 
-- ``code-scanning``: queries run by default in code scanning.
+- ``code-scanning``: queries run by default in CodeQL code scanning on GitHub.
 - ``security-extended``: queries from ``code-scanning``, plus extra security queries with slightly lower precision and severity.
-- ``security-and-quality``: queries from ``code-scanning``, ``security-and-quality``, plus extra maintainability and reliability queries.
+- ``security-and-quality``: queries from ``code-scanning``, ``security-extended``, plus extra maintainability and reliability queries.