Skip to content

Commit 462d8c5

Browse files
committed
Shared: update qldoc
1 parent 6ede0a7 commit 462d8c5

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
@@ -466,8 +466,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
466466
* `observeDiffInformedIncrementalMode`). By default, this is the location
467467
* of the source itself, but this predicate should include any locations
468468
* that are reported as the primary-location of the query or as an
469-
* additional location ("$@" interpolation). For a query that doesn't
470-
* report the source at all, this predicate can be `none()`.
469+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
470+
* that override this predicate should also return the location of the source
471+
* itself. For a query that doesn't report the source at all, this predicate
472+
* should be `none()`.
471473
*/
472474
default Location getASelectedSourceLocation(Node source) { result = source.getLocation() }
473475

@@ -477,8 +479,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
477479
* `observeDiffInformedIncrementalMode`). By default, this is the location
478480
* of the sink itself, but this predicate should include any locations
479481
* that are reported as the primary-location of the query or as an
480-
* additional location ("$@" interpolation). For a query that doesn't
481-
* report the sink at all, this predicate can be `none()`.
482+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
483+
* that override this predicate should also return the location of the sink
484+
* itself. For a query that doesn't report the sink at all, this predicate
485+
* should be `none()`.
482486
*/
483487
default Location getASelectedSinkLocation(Node sink) { result = sink.getLocation() }
484488
}
@@ -615,8 +619,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
615619
* `observeDiffInformedIncrementalMode`). By default, this is the location
616620
* of the source itself, but this predicate should include any locations
617621
* that are reported as the primary-location of the query or as an
618-
* additional location ("$@" interpolation). For a query that doesn't
619-
* report the source at all, this predicate can be `none()`.
622+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
623+
* that override this predicate should also return the location of the source
624+
* itself. For a query that doesn't report the source at all, this predicate
625+
* should be `none()`.
620626
*/
621627
default Location getASelectedSourceLocation(Node source) { result = source.getLocation() }
622628

@@ -626,8 +632,10 @@ module Configs<LocationSig Location, InputSig<Location> Lang> {
626632
* `observeDiffInformedIncrementalMode`). By default, this is the location
627633
* of the sink itself, but this predicate should include any locations
628634
* that are reported as the primary-location of the query or as an
629-
* additional location ("$@" interpolation). For a query that doesn't
630-
* report the sink at all, this predicate can be `none()`.
635+
* additional location ("$@" interpolation). Queries with `@kind path-problem`
636+
* that override this predicate should also return the location of the sink
637+
* itself. For a query that doesn't report the sink at all, this predicate
638+
* should be `none()`.
631639
*/
632640
default Location getASelectedSinkLocation(Node sink) { result = sink.getLocation() }
633641
}

0 commit comments

Comments
 (0)