Skip to content

Commit 4f63584

Browse files
committed
Docs: Highlight that Configuration is not DataFlow::Configuration
I made that mistake when just reading it over (DOH). I think that calling it MyConfiguration makes it a bit more clear that this is a configuration class you wrote yourself :D
1 parent d95b295 commit 4f63584

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/codeql/writing-codeql-queries/creating-path-queries.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ You should use the following template:
5858
import DataFlow::PathGraph
5959
...
6060
61-
from Configuration config, DataFlow::PathNode source, DataFlow::PathNode sink
61+
from MyConfiguration config, DataFlow::PathNode source, DataFlow::PathNode sink
6262
where config.hasFlowPath(source, sink)
6363
select sink.getNode(), source, sink, "<message>"
6464
6565
Where:
6666

6767
- ``DataFlow::Pathgraph`` is the path graph module you need to import from the standard CodeQL libraries.
6868
- ``source`` and ``sink`` are nodes on the `path graph <https://en.wikipedia.org/wiki/Path_graph>`__, and ``DataFlow::PathNode`` is their type.
69-
- ``Configuration`` is a class containing the predicates which define how data may flow between the ``source`` and the ``sink``.
69+
- ``MyConfiguration`` is a class containing the predicates which define how data may flow between the ``source`` and the ``sink``.
7070

7171

7272
The following sections describe the main requirements for a valid path query.

0 commit comments

Comments
 (0)