Skip to content

Commit 286f62e

Browse files
committed
Add a caveat to use the right tool for the situation
1 parent d4c1e14 commit 286f62e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

datafusion/physical-plan/src/execution_plan.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,10 @@ pub trait ExecutionPlan: Debug + DisplayAs + Send + Sync {
265265
/// [`ExecutionPlan`] implementations should follow [the guideline of not
266266
/// spending a long time without reaching an `await`/yield point][async-guideline].
267267
/// This can be achieved by manually returning [`Poll::Pending`] in regular
268-
/// intervals, or the use of [`tokio::task::yield_now()`]. Determination
269-
/// for "regularly" may be made using a timer (being careful with the
270-
/// overhead-heavy syscall needed to take the time) or by counting rows
271-
/// or batches.
268+
/// intervals, or the use of [`tokio::task::yield_now()`] (as appropriate).
269+
/// Determination for "regularly" may be made using a timer (being careful
270+
/// with the overhead-heavy syscall needed to take the time) or by
271+
/// counting rows or batches.
272272
///
273273
/// The cancellation benchmark tracks some cases of how quickly queries can
274274
/// be cancelled.

0 commit comments

Comments
 (0)