Skip to content

Commit 6b90ce0

Browse files
committed
Updates for review comments
1 parent a4f3e5e commit 6b90ce0

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

docs/codeql/codeql-for-visual-studio-code/using-the-codeql-model-editor.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,12 @@ The models are stored in your workspace at ``.github/codeql/extensions/<codeql-m
6565

6666
The models are stored in a series of YAML data extension files, one for each external API. For example:
6767

68-
- ``.github/codeql/extensions/sofa-jraft-java`` - model pack
69-
- ``models``
70-
- ``jmh-core.model.yml`` - model of calls to the ``[email protected]`` dependency.
71-
- ``rocksdbjni.model.yml`` - model of calls to the ``[email protected]`` dependency.
68+
.. code-block::
69+
70+
.github/codeql/extensions/sofa-jraft-java # the model pack directory
71+
models
72+
jmh-core.model.yml # models calls to [email protected]
73+
rocksdbjni.model.yml # models calls to [email protected]
7274
7375
Modeling the public API of a codebase
7476
-------------------------------------
@@ -103,10 +105,12 @@ The models are stored in your workspace at ``.github/codeql/extensions/<codeql-m
103105

104106
The models are stored in a series of YAML data extension files, one for each public method. For example:
105107

106-
- ``.github/codeql/extensions/sofa-jraft-java`` - model pack
107-
- ``models``
108-
- ``com.alipay.sofa.jraft.option.model.yml`` - model of public methods in this Java package.
109-
- ``com.alipay.sofa.jraft.rhea.options.model.yml`` - model of public methods in this Java package.
108+
.. code-block::
109+
110+
.github/codeql/extensions/sofa-jraft-java # the model pack directory
111+
models
112+
com.alipay.sofa.jraft.option.model.yml # models public methods in package
113+
com.alipay.sofa.jraft.rhea.options.model.yml # models public methods in package
110114
111115
The editor will create a separate model file for each package that you model.
112116

docs/codeql/codeql-language-guides/data-extensions-to-model-java-dependencies.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Examples of data extension definitions
7373

7474
The examples in this section are taken from the standard CodeQL Java query pack published by GitHub. They demonstrate how to add tuples to extend extensible predicates that are used by the standard queries.
7575

76-
For details of the *mini DSLs* that define models for each extensible predicate, see ":doc:`extensible-predicates`."
76+
For details of the mini domain-specific langauge that defines models for each extensible predicate, see ":doc:`extensible-predicates`."
7777

7878
Example: Taint sink in the ``java.sql`` package
7979
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)