C++: Apply documentation change suggestion

andersfugmann · jbj · web-flow · commit a358ea8667a2 · 2021-09-28T10:38:02.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
@@ -1593,7 +1593,7 @@ private module SimpleRangeAnalysisCached {
     result = min([max(getTruncatedUpperBounds(expr)), getGuardedUpperBound(expr)])
   }
 
-  /** Holds if `expr` may have been widened */
+  /** Holds if the upper bound of `expr` may have been widened. This means the the upper bound is in practice likely to be overly wide. */
   cached
   predicate upperBoundMayBeWidened(Expr e) {
     isRecursiveExpr(e) and

Original file line number	Diff line number	Diff line change
`@@ -1593,7 +1593,7 @@ private module SimpleRangeAnalysisCached {`
`1593`	`1593`	`result = min([max(getTruncatedUpperBounds(expr)), getGuardedUpperBound(expr)])`
`1594`	`1594`	`}`
`1595`	`1595`
`1596`		- /** Holds if `expr` may have been widened */
	`1596`	+ /** Holds if the upper bound of `expr` may have been widened. This means the the upper bound is in practice likely to be overly wide. */
`1597`	`1597`	`cached`
`1598`	`1598`	`predicate upperBoundMayBeWidened(Expr e) {`
`1599`	`1599`	`isRecursiveExpr(e) and`