diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/index.rst b/docs/codeql/codeql-cli/codeql-cli-reference/index.rst index 69ed60a8546..6e9249ac1d7 100644 --- a/docs/codeql/codeql-cli/codeql-cli-reference/index.rst +++ b/docs/codeql/codeql-cli/codeql-cli-reference/index.rst @@ -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>`__." diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst index d4f1f2dd8d3..87f9f0f5d5a 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst @@ -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 `." +For information about using the CodeQL CLI, see +":ref:`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>`__." \ No newline at end of file +"`CodeQL CLI manual <../../codeql-cli-manual>`__." diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst index 2721dc2b115..75c7113b4a9 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst @@ -282,5 +282,4 @@ repository. Further reading --------------- -- "`CodeQL queries - `" \ No newline at end of file +- ":ref:`CodeQL queries `" diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst index 88571662942..a1cb79220bc 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst @@ -18,7 +18,7 @@ See the following links to learn how to get set up and run CodeQL commands: `: 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 `: 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 `: 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 \ No newline at end of file + testing-query-help-files diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst index 922c4f5e1c5..30636fbfa2c 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst @@ -40,7 +40,7 @@ where ````, 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 -------------------- diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst index 275779c65c1..6506f1caa45 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst +++ b/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst @@ -1,6 +1,6 @@ .. _types-in-java: -Java types +Types in Java ========== You can use CodeQL to find out information about data types used in Java code. This allows you to write queries to identify specific type-related issues.