Document the return value of IndexMapCore::push

indexmap-rs · Jun 25, 2020 · 3c95c02 · 3c95c02
1 parent db5be09
commit 3c95c02
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/Cargo.toml b/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"

diff --git a/src/map_core.rs b/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));