add doc comment for join handle drop behavior

This commit is contained in:
Kevin Donahue 2019-09-14 16:35:27 -04:00
parent e060326910
commit 127feb47f9

View file

@ -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