Document the return value of IndexMapCore::push

Author: cuviper

Cargo.toml

@@ -38,7 +38,7 @@ rayon = { version = "1.0", optional = true }
 [dependencies.hashbrown]
 version = "0.8"
 default-features = false
-features = ["inline-more", "raw"]
+features = ["raw"]
 
 [dev-dependencies]
 itertools = "0.9"

src/map_core.rs

@@ -176,7 +176,8 @@ impl<K, V> IndexMapCore<K, V> {
         }
     }
 
-    /// Append a key-value pair, *without* checking whether it already exists.
+    /// Append a key-value pair, *without* checking whether it already exists,
+    /// and return the pair's new index.
     fn push(&mut self, hash: HashValue, key: K, value: V) -> usize {
         let i = self.entries.len();
         self.indices.insert(hash.get(), i, get_hash(&self.entries));