Skip to content

Commit 0667ae9

Browse files
committed
Auto merge of #33665 - golddranks:thread-park-add-big-picture-explanation, r=aturon
Added a big-picture explanation for thread::park() & co. As I said in https://www.reddit.com/r/rust/comments/4ihvv1/hey_rust_programmers_got_a_question_ask_here/d372s4i, the current explanation of the `park()` and `unpark()` is a bit unclear. It says that they're used for blocking, but then it goes on explaining the semantics in detail, leaving the bigger picture a bit unclear. I added a short high-level explanation that explains how the functions are used. I also exposed the full paths (`thread::park()` and `thread::Thread::unpark()`), because `unpark()`, being a method, is not directly visible at the module level.
2 parents 30422de + 20b9129 commit 0667ae9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/libstd/thread/mod.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,9 @@
101101
//! ## Blocking support: park and unpark
102102
//!
103103
//! Every thread is equipped with some basic low-level blocking support, via the
104-
//! `park` and `unpark` functions.
104+
//! `thread::park()` function and `thread::Thread::unpark()` method. `park()`
105+
//! blocks the current thread, which can then be resumed from another thread by
106+
//! calling the `unpark()` method on the blocked thread's handle.
105107
//!
106108
//! Conceptually, each `Thread` handle has an associated token, which is
107109
//! initially not present:

0 commit comments

Comments
 (0)