hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-29 23:26:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Felicity Chapman <felicitymay@github.com>
This commit is contained in:
James Fletcher
2020-11-15 08:31:40 +00:00
committed by GitHub
parent 52d6503fe0
commit a4a47bf88d
6 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/codeql/codeql-cli/codeql-cli-reference/index.rst
View File

@@ -30,5 +30,5 @@ Learn more about the files you can use when running CodeQL processes and the res
CodeQL CLI commands
-------------------
To view provide detailed information about each CodeQL CLI command,
including its usage and options, visit the "`CodeQL CLI manual <../codeql-cli-manual>`__."
To view detailed information about each CodeQL CLI command,
including its usage and options, add the ``--help`` flag or visit the "`CodeQL CLI manual <../codeql-cli-manual>`__."

6
docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst
View File

@@ -14,8 +14,8 @@ open source software projects. You can use the CodeQL CLI to:
- Create CodeQL databases to use in the CodeQL for Visual Studio Code
- Develop and test custom CodeQL queries to use in your own analyses
For more information about how to use the CodeQL CLI, see
":ref:`CodeQL CLI <codeql-cli>`."
For information about using the CodeQL CLI, see
":ref:`Getting started with the CodeQL CLI <getting-started-with-the-codeql-cli>`."
CodeQL CLI commands
-------------------
@@ -26,4 +26,4 @@ command line. To run a command, use::
codeql [command] [subcommand]
To view the reference documentation for a command, add the ``--help`` flag, or visit the
"`CodeQL CLI manual <../../codeql-cli-manual>`__."
"`CodeQL CLI manual <../../codeql-cli-manual>`__."

3
docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst
View File

@@ -282,5 +282,4 @@ repository.
Further reading
---------------
- "`CodeQL queries
<writing-codeql-queries:codeql-queries>`"
- ":ref:`CodeQL queries <codeql-queries>`"

6
docs/codeql/codeql-cli/using-the-codeql-cli/index.rst
View File

@@ -18,7 +18,7 @@ See the following links to learn how to get set up and run CodeQL commands:
<creating-codeql-databases>`: Create relational
representations of source code that can be queried like any other database.
- :doc:`Analyzing CodeQL databases
- :doc:`Analyzing CodeQL databases with the CodeQL CLI
<analyzing-databases-with-the-codeql-cli>`: Analyze your code using queries
written in a specially-designed, object-oriented query language.
@@ -39,7 +39,7 @@ See the following links to learn how to get set up and run CodeQL commands:
- :doc:`Testing query help files <testing-query-help-files>`:
Test query help files by rendering them as markdown to ensure they are valid
before uploading them to the CodeQL repository or using them in code scanning.
before adding them to the CodeQL repository or using them in code scanning.
.. toctree::
:titlesonly:
@@ -53,4 +53,4 @@ See the following links to learn how to get set up and run CodeQL commands:
using-custom-queries-with-the-codeql-cli
creating-codeql-query-suites
testing-custom-queries
testing-query-help-files
testing-query-help-files

2
docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst
View File

@@ -40,7 +40,7 @@ where ``<database>``, the path to the CodeQL database you
want to upgrade, must be specified.
For full details of all the options you can use when upgrading databases,
see the `database upgrade reference documentation <../codeql-cli-manual/database-upgrade.html>`.
see the "`database upgrade <../codeql-cli-manual/database-upgrade.html>`__" reference documentation.
Progress and results
--------------------