Skip to content

Commit a537f34

Browse files
committed
Shared: Tweak basic block documentation
1 parent 9547a5c commit a537f34

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

shared/controlflow/codeql/controlflow/BasicBlock.qll

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,17 @@ module Make<LocationSig Location, InputSig<Location> Input> {
182182
bbIDominates(this, succ) and
183183
// The above is not sufficient to ensure that `succ` can only be reached
184184
// through `s`. To see why, consider this example corresponding to an
185-
// `if` expression without an `else` block:
185+
// `if` statement without an `else` block and whe `A` is the basic block
186+
// following the `if` statement:
186187
// ```
187-
// ... --> cond --[true]--> ... --> if expr
188+
// ... --> cond --[true]--> ... --> A
188189
// \ /
189190
// ----[false]-----------
190191
// ```
191-
// The basic block for `cond` immediately dominates the directly
192-
// succeeding basic block for the `if` expression. But the `if`
193-
// expression is not immediately controlled by the `cond` basic block and
194-
// the `false` edge since it is also possible to reach the `if`
195-
// expression via the `true` edge.
192+
// Here `A` is a direct successor of `cond` along the `false` edge and it
193+
// is immediately dominated by `cond`, but `A` is not controlled by the
194+
// `false` edge since it is also possible to reach `A` via the `true`
195+
// edge.
196196
//
197197
// Note that the first and third conjunct implies the second. But
198198
// explicitly including the second conjunct leads to a better join order.

0 commit comments

Comments
 (0)