about summary refs log tree commit diff
path: root/src/libstd/thread.rs
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2015-02-24 07:13:07 +0530
committerManish Goregaokar <manishsmail@gmail.com>2015-02-24 12:08:00 +0530
commit0dc720b479de42465229775ce4478c01b6ac4aea (patch)
treed9130e674f68d01e2773c481c1805ef683ca0c54 /src/libstd/thread.rs
parent2890508d97af287a136ac50ffa13a1c0a3e32e4e (diff)
parent189409f85b8479ccbaf15c7da2cdc1fcb1a20794 (diff)
downloadrust-0dc720b479de42465229775ce4478c01b6ac4aea.tar.gz
rust-0dc720b479de42465229775ce4478c01b6ac4aea.zip
Rollup merge of #22604 - aochagavia:docs, r=alexcrichton
Diffstat (limited to 'src/libstd/thread.rs')
-rw-r--r--src/libstd/thread.rs13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/libstd/thread.rs b/src/libstd/thread.rs
index 1f70e1526a0..6aad2bbcc7f 100644
--- a/src/libstd/thread.rs
+++ b/src/libstd/thread.rs
@@ -342,12 +342,15 @@ impl Builder {
     }
 }
 
-/// Spawn a new, returning a join handle for it.
+/// Spawn a new thread, returning a `JoinHandle` for it.
 ///
-/// The child thread may outlive the parent (unless the parent thread
-/// is the main thread; the whole process is terminated when the main
-/// thread finishes.) The join handle can be used to block on
-/// termination of the child thread, including recovering its panics.
+/// The join handle will implicitly *detach* the child thread upon being
+/// dropped. In this case, the child thread may outlive the parent (unless
+/// the parent thread is the main thread; the whole process is terminated when
+/// the main thread finishes.) Additionally, the join handle provides a `join`
+/// method that can be used to join the child thread. If the child thread
+/// panics, `join` will return an `Err` containing the argument given to
+/// `panic`.
 ///
 /// # Panics
 ///