Auto merge of #31684 - tmiasko:alternate-stack, r=alexcrichton

[rust.git] / src / libcollections / btree / map.rs

diff --git a/src/libcollections/btree/map.rs b/src/libcollections/btree/map.rs
index 0ced4e1952aa51b4daa97a9bf2c3868e6b356beb..7207e7b151c1eae3966022d942574d4cc9a672c2 100644 (file)
--- a/src/libcollections/btree/map.rs
+++ b/src/libcollections/btree/map.rs
@@ -375,9 +375,10 @@ pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut V> where K: Borrow<
     ///
     /// If the map did not have this key present, `None` is returned.
     ///
-    /// If the map did have this key present, the key is not updated, the
-    /// value is updated and the old value is returned.
-    /// See the [module-level documentation] for more.
+    /// If the map did have this key present, the value is updated, and the old
+    /// value is returned. The key is not updated, though; this matters for
+    /// types that can be `==` without being identical. See the [module-level
+    /// documentation] for more.
     ///
     /// [module-level documentation]: index.html#insert-and-complex-keys
     ///