Skip to content

Commit 127feb4

Browse files
committed
add doc comment for join handle drop behavior
1 parent e060326 commit 127feb4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/task/task.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ impl fmt::Debug for Task {
4646

4747
/// A handle that awaits the result of a task.
4848
///
49+
/// Dropping a [`JoinHandle`] will detach the task, meaning that there is no longer
50+
/// a handle to the task and no way to `join` on it.
51+
///
4952
/// Created when a task is [spawned].
5053
///
5154
/// [spawned]: fn.spawn.html

0 commit comments

Comments
 (0)