From 6debbc0d3e57a565f85e401f0dd4c7132f92a94e Mon Sep 17 00:00:00 2001 From: James Fletcher <42464962+jf205@users.noreply.github.com> Date: Tue, 13 Sep 2022 19:22:15 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Felicity Chapman --- .../codeql/codeql-cli/getting-started-with-the-codeql-cli.rst | 2 +- docs/codeql/reusables/download-github-database.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst index c188c0a9c72..1984b12d6d8 100644 --- a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst @@ -51,7 +51,7 @@ Conditions `__. on your use case: * If you want to use the most up to date CodeQL tools and features, download the version tagged ``latest``. - * If you want to generate code scanning data to upload to GitHub Enterprise server, then download the version that is compatible with the CodeQL CLI used in your CI system. For more information, see "`Installing CodeQL CLI in your CI system `__" in the GitHub documentation. + * If you want to generate code scanning data to upload to GitHub Enterprise server, then download the version that is compatible with the CodeQL CLI used in your CI system. For more information, see "`Installing CodeQL CLI in your CI system `__" in the GitHub documentation. If you use Linux, Windows, or macOS version 10.14 ("Mojave") or earlier, simply `download the zip archive diff --git a/docs/codeql/reusables/download-github-database.rst b/docs/codeql/reusables/download-github-database.rst index 2e4bfd9a58c..02d41114da5 100644 --- a/docs/codeql/reusables/download-github-database.rst +++ b/docs/codeql/reusables/download-github-database.rst @@ -1,11 +1,11 @@ GitHub stores CodeQL databases for over 200,000 repos on GitHub.com, which you can download using the REST API. The list of repos is constantly growing and evolving to make sure that it includes the most interesting codebases for security research. -You can check if a repo has any CodeQL databases available to download using the `/repos///code-scanning/codeql/databases` endpoint. +You can check if a repository has any CodeQL databases available for download using the ``/repos///code-scanning/codeql/databases`` endpoint. For example, to check for CodeQL databases using the `GitHub CLI `__ you would run:: gh api /repos///code-scanning/codeql/databases/ -This command will return information about the CodeQL databases that are available for a repository, including the language the database represents, and when the database was last updated. If no CodeQL databases are available, the response will be empty. +This command returns information about any CodeQL databases that are available for a repository, including the language the database represents, and when the database was last updated. If no CodeQL databases are available, the response is empty. When you have confirmed that a CodeQL database exists for the language you are interested in, you can download it using the following command::