Python: Explicitly mention lack of transitive flow in asSource/asSink

This commit is contained in:
Asger F
2022-06-28 09:46:26 +02:00
parent 9b27a7cbcd
commit a033338d20

View File

@@ -121,6 +121,9 @@ module API {
* obj.prop = x
* foo.bar(obj);
* ```
*
* This predicate does not include nodes transitively reaching the sink by data flow;
* use `getAValueReachingSink` for that.
*/
DataFlow::Node asSink() { Impl::rhs(this, result) }
@@ -146,6 +149,9 @@ module API {
* # API::moduleImport("re").getMember("escape").getReturn().asSource()
* re.escape()
* ```
*
* This predicate does not include nodes transitively reachable by data flow;
* use `getAValueReachableFromSource` for that.
*/
DataFlow::LocalSourceNode asSource() { Impl::use(this, result) }