Skip to content

Commit e16647f

Browse files
authored
Merge pull request #14731 from owen-mc/docs/dataflow-never-skip
Docs: document dataflow `neverSkip` (and expand section on hidden nodes)
2 parents 4cc75c5 + 38766c4 commit e16647f

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/ql-libraries/dataflow/dataflow.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -618,12 +618,31 @@ impact on performance for large databases.
618618

619619
### Hidden nodes
620620

621-
Certain synthetic nodes can be hidden to exclude them from occurring in path
622-
explanations. This is done through the following predicate:
621+
Certain synthetic nodes are hidden by default to prevent them from occurring in
622+
path explanations. Which nodes are included in this is determined by the
623+
following predicate:
624+
623625
```ql
624626
predicate nodeIsHidden(Node n)
625627
```
626628

629+
To include these nodes in path explanations, add the following to a
630+
configuration:
631+
632+
```ql
633+
predicate includeHiddenNodes() { any() }
634+
```
635+
636+
### Show more nodes in path explanations
637+
638+
Path explanations skip over most nodes and only show the important nodes in a
639+
path. To ensure that particular nodes are shown, define the following predicate
640+
in a configuration:
641+
642+
```ql
643+
predicate neverSkip(Node n)
644+
```
645+
627646
### Unreachable nodes
628647

629648
Consider:

0 commit comments

Comments
 (0)