Skip to content

Commit 04fae40

Browse files
committed
Shared: update qldoc
1 parent a7f7d1f commit 04fae40

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

shared/dataflow/codeql/dataflow/DataFlow.qll

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -454,8 +454,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
454454
* `observeDiffInformedIncrementalMode`). By default, this is the location
455455
* of the source itself, but this predicate should include any locations
456456
* that are reported as the primary-location of the query or as an
457-
* additional location ("$@" interpolation). For a query that doesn't
458-
* report the source at all, this predicate can be `none()`.
457+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
458+
* that override this predicate should also return the location of the source
459+
* itself. For a query that doesn't report the source at all, this predicate
460+
* should be `none()`.
459461
*/
460462
default Location getASelectedSourceLocation(Node source) { result = source.getLocation() }
461463

@@ -465,8 +467,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
465467
* `observeDiffInformedIncrementalMode`). By default, this is the location
466468
* of the sink itself, but this predicate should include any locations
467469
* that are reported as the primary-location of the query or as an
468-
* additional location ("$@" interpolation). For a query that doesn't
469-
* report the sink at all, this predicate can be `none()`.
470+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
471+
* that override this predicate should also return the location of the sink
472+
* itself. For a query that doesn't report the sink at all, this predicate
473+
* should be `none()`.
470474
*/
471475
default Location getASelectedSinkLocation(Node sink) { result = sink.getLocation() }
472476
}
@@ -603,8 +607,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
603607
* `observeDiffInformedIncrementalMode`). By default, this is the location
604608
* of the source itself, but this predicate should include any locations
605609
* that are reported as the primary-location of the query or as an
606-
* additional location ("$@" interpolation). For a query that doesn't
607-
* report the source at all, this predicate can be `none()`.
610+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
611+
* that override this predicate should also return the location of the source
612+
* itself. For a query that doesn't report the source at all, this predicate
613+
* should be `none()`.
608614
*/
609615
default Location getASelectedSourceLocation(Node source) { result = source.getLocation() }
610616

@@ -614,8 +620,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
614620
* `observeDiffInformedIncrementalMode`). By default, this is the location
615621
* of the sink itself, but this predicate should include any locations
616622
* that are reported as the primary-location of the query or as an
617-
* additional location ("$@" interpolation). For a query that doesn't
618-
* report the sink at all, this predicate can be `none()`.
623+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
624+
* that override this predicate should also return the location of the sink
625+
* itself. For a query that doesn't report the sink at all, this predicate
626+
* should be `none()`.
619627
*/
620628
default Location getASelectedSinkLocation(Node sink) { result = sink.getLocation() }
621629
}

0 commit comments

Comments
 (0)