Document that Index ops can panic on HashMap & BTreeMap.

Fixes rust-lang/rust#47011.
cuviper · Jan 29, 2018 · 5b63575 · 5b63575
1 parent 4a82c56
commit 5b63575
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/map.rs b/map.rs
@@ -1384,9 +1384,14 @@ impl<'a, K, Q: ?Sized, V, S> Index<&'a Q> for HashMap<K, V, S>
 {
     type Output = V;
 
+    /// Returns a reference to the value corresponding to the supplied key.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the key is not present in the `HashMap`.
     #[inline]
-    fn index(&self, index: &Q) -> &V {
-        self.get(index).expect("no entry found for key")
+    fn index(&self, key: &Q) -> &V {
+        self.get(key).expect("no entry found for key")
     }
 }