Explain that RefCell is single-threaded.

Fixes #21469.
rust-lang · Jan 21, 2015 · 973c2f6 · 973c2f6
1 parent 6869645
commit 973c2f6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/libcore/cell.rs b/src/libcore/cell.rs
@@ -74,6 +74,10 @@
 //! }
 //! ```
 //!
+//! Note that this example uses `Rc<T>` and not `Arc<T>`. `RefCell<T>`s are for single-threaded
+//! scenarios. Consider using `Mutex<T>` if you need shared mutability in a multi-threaded
+//! situation.
+//!
 //! ## Implementation details of logically-immutable methods
 //!
 //! Occasionally it may be desirable not to expose in an API that