Merge #322

322: clarify the iteration order of IndexMap / IndexSet r=japaric a=japaric

closes #321

Co-authored-by: Jorge Aparicio <[email protected]>

Author: bors[bot]

src/indexmap.rs

@@ -510,7 +510,7 @@ where
         N
     }
 
-    /// Return an iterator over the keys of the map, in their order
+    /// Return an iterator over the keys of the map, in insertion order
     ///
     /// ```
     /// use heapless::FnvIndexMap;
@@ -528,7 +528,7 @@ where
         self.core.entries.iter().map(|bucket| &bucket.key)
     }
 
-    /// Return an iterator over the values of the map, in their order
+    /// Return an iterator over the values of the map, in insertion order
     ///
     /// ```
     /// use heapless::FnvIndexMap;
@@ -546,7 +546,7 @@ where
         self.core.entries.iter().map(|bucket| &bucket.value)
     }
 
-    /// Return an iterator over mutable references to the the values of the map, in their order
+    /// Return an iterator over mutable references to the the values of the map, in insertion order
     ///
     /// ```
     /// use heapless::FnvIndexMap;
@@ -568,7 +568,7 @@ where
         self.core.entries.iter_mut().map(|bucket| &mut bucket.value)
     }
 
-    /// Return an iterator over the key-value pairs of the map, in their order
+    /// Return an iterator over the key-value pairs of the map, in insertion order
     ///
     /// ```
     /// use heapless::FnvIndexMap;
@@ -588,7 +588,7 @@ where
         }
     }
 
-    /// Return an iterator over the key-value pairs of the map, in their order
+    /// Return an iterator over the key-value pairs of the map, in insertion order
     ///
     /// ```
     /// use heapless::FnvIndexMap;

src/indexset.rs

@@ -111,7 +111,7 @@ where
         self.map.capacity()
     }
 
-    /// Return an iterator over the values of the set, in their order
+    /// Return an iterator over the values of the set, in insertion order
     ///
     /// # Examples
     ///
@@ -122,7 +122,7 @@ where
     /// set.insert("a").unwrap();
     /// set.insert("b").unwrap();
     ///
-    /// // Will print in an arbitrary order.
+    /// // Will print in insertion order: a, b
     /// for x in set.iter() {
     ///     println!("{}", x);
     /// }
@@ -195,7 +195,7 @@ where
     /// let mut a: FnvIndexSet<_, 16> = [1, 2, 3].iter().cloned().collect();
     /// let mut b: FnvIndexSet<_, 16> = [4, 2, 3, 4].iter().cloned().collect();
     ///
-    /// // Print 1, 4 in that order order.
+    /// // Print 1, 4 in that order.
     /// for x in a.symmetric_difference(&b) {
     ///     println!("{}", x);
     /// }