Add more explanation on RefCell::get_mut

diff --git a/src/libcore/cell.rs b/src/libcore/cell.rs
index ba04cbb0543cd6de56de80d2412cda33e8525bfc..f62057b3a52d08c4294fe00c166755b86b6b7b64 100644 (file)
--- a/src/libcore/cell.rs
+++ b/src/libcore/cell.rs
@@ -725,6 +725,15 @@ pub fn as_ptr(&self) -> *mut T {
     /// This call borrows `RefCell` mutably (at compile-time) so there is no
     /// need for dynamic checks.
     ///
+    /// However be cautious: this method expects `self` to be mutable, which is
+    /// generally not the case when using a `RefCell`. Take a look at the
+    /// [`borrow_mut`] method instead if `self` isn't mutable.
+    ///
+    /// Also, please be aware that this method is only for special circumstances and is usually
+    /// not you want. In case of doubt, use [`borrow_mut`] instead.
+    ///
+    /// [`borrow_mut`]: #method.borrow_mut
+    ///
     /// # Examples
     ///
     /// ```