Skip to content

Commit 3c1f67d

Browse files
Apply suggestions from code review
Co-authored-by: Felicity Chapman <felicitymay@github.com>
1 parent 68f0505 commit 3c1f67d

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

docs/codeql/codeql-cli/creating-codeql-query-suites.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,24 +142,23 @@ recommend filtering on the query ``id``, which is a unique and stable identifier
142142
each query. The following three query suite definitions are semantically identical and
143143
filter by the query ``id``:
144144

145-
Matches all queries in the default suite of ``codeql/cpp-queries``, except for the two queries with either given ``id``::
145+
This filter matches all the queries in the default suite of ``codeql/cpp-queries``, except for the two queries with the excluded identifiers::
146146

147147
- qlpack: codeql/cpp-queries
148148
- exclude:
149149
id:
150150
- cpp/cleartext-transmission
151151
- cpp/cleartext-storage-file
152152

153-
As above, but splits the matching into two ``exclude`` instructions::
153+
In this example, a separate ``exclude`` instruction is used for each query::
154154

155155
- qlpack: codeql/cpp-queries
156156
- exclude:
157157
id: cpp/cleartext-transmission
158158
- exclude:
159159
id: cpp/cleartext-storage-file
160160

161-
As above, but uses a regular expression to match the ``id`` (assuming
162-
that the regular expression matches exactly the previous queries)::
161+
In this example, a regular expression excludes the same two queries. It would also exclude any future queries added to the suite with identifiers that begin: ``cpp/cleartext-``::
163162

164163
- qlpack: codeql/cpp-queries
165164
- exclude:
@@ -182,8 +181,7 @@ and ``@precision high`` from the ``my-custom-queries`` directory, use::
182181
kind: problem
183182
precision: very-high
184183

185-
Note that the following query suite definition is not equivalent to the above
186-
definition. This definition will select queries that are ``@kind problem`` *or*
184+
Note that the following query suite definition behaves differently from the definition above. This definition selects queries that are ``@kind problem`` *or*
187185
are ``@precision very-high``::
188186

189187
- queries: my-custom-queries

0 commit comments

Comments
 (0)