Skip to content

Commit 1120498

Browse files
committed
Reword based on review comments
1 parent ac54caa commit 1120498

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/codeql/ql-language-reference/annotations.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -295,15 +295,16 @@ at the places where it is called.
295295
**Available for**: |non-member predicates|
296296

297297
The ``pragma[inline_late]`` annotation must be used in conjunction with a
298-
``bindingset[...]`` pragma. Together, they tell the QL optimiser to inline
299-
the annotated predicate after join ordering and to join order callers and callee
300-
based on the given binding set. This can be useful to prevent the optimiser
301-
from choosing a sub-optimal join order.
298+
``bindingset[...]`` pragma. Together, they tell the QL optimiser to use the
299+
specified binding set for assessing join orders both in the body of the
300+
annotated predicate and at call sites and to inline the body into call sites
301+
after join ordering. This can be useful to prevent the optimiser from choosing
302+
a sub-optimal join order.
302303

303304
For instance, in the example below, the ``pragma[inline_late]`` and
304305
``bindingset[x]`` annotations specifiy that calls to ``p`` should be join ordered
305306
in a context where ``x`` is already bound. This forces the join orderer to
306-
order the ``q(x)`` call before ``p(x)``, which is more computationally efficient
307+
order ``q(x)`` before ``p(x)``, which is more computationally efficient
307308
than ordering ``p(x)`` before ``q(x)``.
308309

309310
.. code-block:: ql

0 commit comments

Comments
 (0)