Add note about HashMap::capacity's bounds

Fixes #24591
rust-lang · Nov 4, 2015 · e9989d5 · e9989d5
1 parent a216e84
commit e9989d5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/libstd/collections/hash/map.rs b/src/libstd/collections/hash/map.rs
@@ -601,6 +601,9 @@ impl<K, V, S> HashMap<K, V, S>
 
     /// Returns the number of elements the map can hold without reallocating.
     ///
+    /// This number is a lower bound; the `HashMap<K, V>` might be able to hold
+    /// more, but is guaranteed to be able to hold at least this many.
+    ///
     /// # Examples
     ///
     /// ```