From 20b912961774add5a83d66404a079238d088afbd Mon Sep 17 00:00:00 2001 From: Pyry Kontio Date: Mon, 16 May 2016 14:01:21 +0900 Subject: Added a big-picture explanation for thread::park() & co. --- src/libstd/thread/mod.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/libstd') 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: -- cgit 1.4.1-3-g733a5