From: Pyry Kontio <pyry.kontio@drasa.eu>
Date: Mon, 16 May 2016 05:01:21 +0000 (+0900)
Subject: Added a big-picture explanation for thread::park() & co.
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=20b912961774add5a83d66404a079238d088afbd;p=rust.git

Added a big-picture explanation for thread::park() & co.
---

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: