about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorPyry Kontio <pyry.kontio@drasa.eu>2016-05-16 14:01:21 +0900
committerPyry Kontio <pyry.kontio@drasa.eu>2016-05-16 14:01:21 +0900
commit20b912961774add5a83d66404a079238d088afbd (patch)
treed2083249cd9d16d28ea8ed47f720d99125dcf7cb /src/libstd
parentbb39c4925a792b1dbb2bfa0323339fdf4297c4ac (diff)
downloadrust-20b912961774add5a83d66404a079238d088afbd.tar.gz
rust-20b912961774add5a83d66404a079238d088afbd.zip
Added a big-picture explanation for thread::park() & co.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/thread/mod.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index 99e6ba8c770..dc26370590c 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -101,7 +101,9 @@
 //! ## Blocking support: park and unpark
 //!
 //! Every thread is equipped with some basic low-level blocking support, via the
-//! `park` and `unpark` functions.
+//! `thread::park()` function and `thread::Thread::unpark()` method. `park()`
+//! blocks the current thread, which can then be resumed from another thread by
+//! calling the `unpark()` method on the blocked thread's handle.
 //!
 //! Conceptually, each `Thread` handle has an associated token, which is
 //! initially not present: