Python: Comment to highlight convention

yoff · yoff · commit 67710eaed7e3 · 2022-09-06T17:43:34.000+02:00
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowUtil.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowUtil.qll
@@ -15,7 +15,8 @@ predicate localFlowStep(Node nodeFrom, Node nodeTo) {
   simpleLocalFlowStep(nodeFrom, nodeTo)
   or
   // Simple flow through library code is included in the exposed local
-  // step relation, even though flow is technically inter-procedural
+  // step relation, even though flow is technically inter-procedural.
+  // This is a convention followed across languages.
   FlowSummaryImpl::Private::Steps::summaryThroughStepValue(nodeFrom, nodeTo, _)
 }
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@ predicate localFlowStep(Node nodeFrom, Node nodeTo) {`
`15`	`15`	`simpleLocalFlowStep(nodeFrom, nodeTo)`
`16`	`16`	`or`
`17`	`17`	`// Simple flow through library code is included in the exposed local`
`18`		`- // step relation, even though flow is technically inter-procedural`
	`18`	`+ // step relation, even though flow is technically inter-procedural.`
	`19`	`+ // This is a convention followed across languages.`
`19`	`20`	`FlowSummaryImpl::Private::Steps::summaryThroughStepValue(nodeFrom, nodeTo, _)`
`20`	`21`	`}`
`21`	`22`