Skip to content

Commit 5ec1fc1

Browse files
authored
Apply suggestions from code review
1 parent d0547cd commit 5ec1fc1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/codeql/codeql-cli/extractor-options.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ setting extractor configuration options through the CodeQL CLI.
1010
About extractor options
1111
-----------------------
1212

13-
Each extractor defines its own set of configuration options. To find out which options are available for a particular extractor, you can run ``codeql resolve languages`` or ``codeql resolve extractor`` with the ``--format=betterjson`` option. The ``betterjson`` output format provides the root paths of extractors and additional information. The output of ``codeql resolve extractor --format=betterjson`` will often be formatted like the following example::
13+
Each extractor defines its own set of configuration options. To find out which options are available for a particular extractor, you can run ``codeql resolve languages`` or ``codeql resolve extractor`` with the ``--format=betterjson`` option. The ``betterjson`` output format provides the root paths of extractors and additional information. The output of ``codeql resolve extractor --format=betterjson`` will often be formatted like the following example:
1414

1515
.. code-block:: json
1616
@@ -95,7 +95,7 @@ You can also set extractor options through a file. The CodeQL CLI subcommands th
9595

9696
Each option file contains a tree structure of nested maps. At the root is an extractor map key, and beneath it are map keys that correspond to extractor names. Starting at the third level, there are extractor options and option groups.
9797

98-
In JSON::
98+
In JSON:
9999

100100
.. code-block:: json
101101
@@ -111,7 +111,7 @@ In JSON::
111111
}
112112
113113
114-
In YAML::
114+
In YAML:
115115

116116
.. code-block:: yaml
117117
@@ -129,7 +129,7 @@ The value for an option group (of type ``object``) must be a map, which may cont
129129

130130
Each extractor option value must match the regular expression pattern of the extractor option (if it exists), and it must not contain newline characters.
131131

132-
Assigning an extractor option that does not exist is an error. You can make the CodeQL CLI ignore unknown extractor options by using a special ``__allow_unknown_properties`` Boolean field. For example, the following option file asks the CodeQL CLI to ignore all unknown extractor options and option groups under ``group1``::
132+
Assigning an extractor option that does not exist is an error. You can make the CodeQL CLI ignore unknown extractor options by using a special ``__allow_unknown_properties`` Boolean field. For example, the following option file asks the CodeQL CLI to ignore all unknown extractor options and option groups under ``group1``:
133133

134134
.. code-block:: yaml
135135

0 commit comments

Comments
 (0)