Add explanation to the join function

rust-threadpool · Sep 9, 2017 · 5a6c22f · 5a6c22f
1 parent 3a07c5d
commit 5a6c22f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -584,6 +584,9 @@ impl ThreadPool {
     ///
     /// Calling `join` on an empty pool will cause an immediate return.
     /// `join` may be called from multiple threads concurrently.
+    /// A `join` is an atomic point in time. All threads joining before the join
+    /// event will exit together even if the pool is processing new jobs by the
+    /// time they get scheduled.
     ///
     /// Calling `join` from a thread within the pool will cause a deadlock. This
     /// behavior is considered safe.