From e336e83a3b0ff2ae9337d825bbc5d15b98403d6c Mon Sep 17 00:00:00 2001 From: Frank McSherry Date: Mon, 18 Nov 2019 14:35:29 -0500 Subject: [PATCH] Clarify execute blocking behavior. fixes #293 --- timely/src/execute.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/timely/src/execute.rs b/timely/src/execute.rs index 38c1f72c8..3c45ffbb5 100644 --- a/timely/src/execute.rs +++ b/timely/src/execute.rs @@ -100,7 +100,11 @@ where /// to recover the result `T` values from the local workers. /// /// *Note*: if the caller drops the result of `execute`, the drop code will -/// block awaiting the completion of the timely computation. +/// block awaiting the completion of the timely computation. If the result +/// of the method is not captured it will be dropped, which gives the experience +/// of `execute` blocking; to regain control after `execute` be sure to +/// capture the results and drop them only when the calling thread has no +/// other work to perform. /// /// # Examples /// ```rust