Skip to content

Commit a40b7ef

Browse files
Apply suggestions from code review
Co-authored-by: Henry Mercer <henrymercer@github.com>
1 parent d892304 commit a40b7ef

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/codeql/codeql-cli/about-codeql-packs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The following properties are supported in ``qlpack.yml`` files.
141141
upgrades: .
142142

143143
- Core language packs only
144-
- The path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure a databasae created with a different version of the CodeQL CLI is compatible with the current version.
144+
- The path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure a database created with a different version of the CodeQL CLI is compatible with the current version.
145145
* - ``authors``
146146
- .. code-block:: yaml
147147

@@ -275,7 +275,7 @@ Each of the languages in the CodeQL repository has four main CodeQL packs:
275275
Core library pack
276276
~~~~~~~~~~~~~~~~~
277277

278-
Here is an example ``qlpack.yml`` file for `C/C++ analysis libraries
278+
Here is an example ``qlpack.yml`` file for the `C/C++ analysis libraries
279279
<https://github.com/github/codeql/blob/main/cpp/ql/lib/qlpack.yml>`__
280280
core language pack:
281281

@@ -290,7 +290,7 @@ core language pack:
290290
Some extra notes on the following properties:
291291

292292
- ``library``: Indicates that this is a library pack with no executable queries. It is only meant to be used as a dependency for other packs.
293-
- ``dbscheme`` and ``upgrades``: Properties internal to the CodeQL CLI and should only be defined in the core QL pack for a language.
293+
- ``dbscheme`` and ``upgrades``: These properties are internal to the CodeQL CLI and should only be defined in the core QL pack for a language.
294294

295295

296296
Core query pack

docs/codeql/reusables/test-qlpack.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
extractor: java
77
tests: .
88
9-
This ``qlpack.yml`` file states that ``my-github-user/my-query-tests`` depends on ``my-github-user/my-custom-queries`` at a version greater than or equal to 1.2.3 and less than 2.0.0. It also declares that the CLI should use the Java ``extractor`` when creating test databases. The ``tests: .`` line declares that all ``.ql`` files in the pack should be run as tests when ``codeql test run`` is run with the ``--strict-test-discovery`` option. Typically, test packs do not contain a ``version`` property. This prevents them from being inadvertently not published.
9+
This ``qlpack.yml`` file states that ``my-github-user/my-query-tests`` depends on ``my-github-user/my-custom-queries`` at a version greater than or equal to 1.2.3 and less than 2.0.0. It also declares that the CLI should use the Java ``extractor`` when creating test databases. The ``tests: .`` line declares that all ``.ql`` files in the pack should be run as tests when ``codeql test run`` is run with the ``--strict-test-discovery`` option. Typically, test packs do not contain a ``version`` property. This prevents them from being inadvertently published.

0 commit comments

Comments
 (0)