From 127feb47f9a14fb689193a54b151381c6d5c5ea9 Mon Sep 17 00:00:00 2001 From: Kevin Donahue Date: Sat, 14 Sep 2019 16:35:27 -0400 Subject: [PATCH] add doc comment for join handle drop behavior --- src/task/task.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/task/task.rs b/src/task/task.rs index c0d52db..8ffe821 100644 --- a/src/task/task.rs +++ b/src/task/task.rs @@ -46,6 +46,9 @@ impl fmt::Debug for Task { /// A handle that awaits the result of a task. /// +/// Dropping a [`JoinHandle`] will detach the task, meaning that there is no longer +/// a handle to the task and no way to `join` on it. +/// /// Created when a task is [spawned]. /// /// [spawned]: fn.spawn.html