C++: Apply documentation change suggestion

andersfugmann · jbj · web-flow · commit c7ea7ca5cd96 · 2021-09-28T09:40:25.000+02:00
Co-authored-by: Jonas Jensen &lt;jbj@github.com&gt;
diff --git a/cpp/ql/lib/semmle/code/cpp/rangeanalysis/SimpleRangeAnalysis.qll b/cpp/ql/lib/semmle/code/cpp/rangeanalysis/SimpleRangeAnalysis.qll
@@ -1597,7 +1597,8 @@ private module SimpleRangeAnalysisCached {
   cached
   predicate upperBoundMayBeWidened(Expr e) {
     isRecursiveExpr(e) and
-    // Corresponds to taking max on the RHS
+    // Widening is not a problem if the post-analysis in `getGuardedUpperBound` has overridden the widening.
+    // Note that the RHS of `<` may be multi-valued.
     not getGuardedUpperBound(e) < getTruncatedUpperBounds(e)
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1597,7 +1597,8 @@ private module SimpleRangeAnalysisCached {`
`1597`	`1597`	`cached`
`1598`	`1598`	`predicate upperBoundMayBeWidened(Expr e) {`
`1599`	`1599`	`isRecursiveExpr(e) and`
`1600`		`- // Corresponds to taking max on the RHS`
	`1600`	+ // Widening is not a problem if the post-analysis in `getGuardedUpperBound` has overridden the widening.
	`1601`	+ // Note that the RHS of `<` may be multi-valued.
`1601`	`1602`	`not getGuardedUpperBound(e) < getTruncatedUpperBounds(e)`
`1602`	`1603`	`}`
`1603`	`1604`