clean up documentation examples

src/map.rs

@@ -398,10 +398,9 @@ where
     /// use papaya::HashMap;
     ///
     /// let map = HashMap::new();
-    /// let m = map.pin();
-    /// m.insert(1, "a");
-    /// assert_eq!(m.contains_key(&1), true);
-    /// assert_eq!(m.contains_key(&2), false);
+    /// map.pin().insert(1, "a");
+    /// assert_eq!(map.pin().contains_key(&1), true);
+    /// assert_eq!(map.pin().contains_key(&2), false);
     /// ```
     #[inline]
     pub fn contains_key<Q>(&self, key: &Q, guard: &impl Guard) -> bool
@@ -427,10 +426,9 @@ where
     /// use papaya::HashMap;
     ///
     /// let map = HashMap::new();
-    /// let m = map.pin();
-    /// m.insert(1, "a");
-    /// assert_eq!(m.get(&1), Some(&"a"));
-    /// assert_eq!(m.get(&2), None);
+    /// map.pin().insert(1, "a");
+    /// assert_eq!(map.pin().get(&1), Some(&"a"));
+    /// assert_eq!(map.pin().get(&2), None);
     /// ```
     #[inline]
     pub fn get<'g, Q>(&self, key: &Q, guard: &'g impl Guard) -> Option<&'g V>
@@ -462,10 +460,9 @@ where
     /// use papaya::HashMap;
     ///
     /// let map = HashMap::new();
-    /// let m = map.pin();
-    /// m.insert(1, "a");
-    /// assert_eq!(m.get_key_value(&1), Some((&1, &"a")));
-    /// assert_eq!(m.get_key_value(&2), None);
+    /// map.pin().insert(1, "a");
+    /// assert_eq!(map.pin().get_key_value(&1), Some((&1, &"a")));
+    /// assert_eq!(map.pin().get_key_value(&2), None);
     /// ```
     #[inline]
     pub fn get_key_value<'g, Q>(&self, key: &Q, guard: &'g impl Guard) -> Option<(&'g K, &'g V)>
@@ -499,12 +496,9 @@ where
     /// assert_eq!(map.pin().insert(37, "a"), None);
     /// assert_eq!(map.pin().is_empty(), false);
     ///
-    /// // note: you can also re-use a map pin like so:
-    /// let m = map.pin();
-    ///
-    /// m.insert(37, "b");
-    /// assert_eq!(m.insert(37, "c"), Some(&"b"));
-    /// assert_eq!(m.get(&37), Some(&"c"));
+    /// map.pin().insert(37, "b");
+    /// assert_eq!(map.pin().insert(37, "c"), Some(&"b"));
+    /// assert_eq!(map.pin().get(&37), Some(&"c"));
     /// ```
     #[inline]
     pub fn insert<'g>(&self, key: K, value: V, guard: &'g impl Guard) -> Option<&'g V> {
@@ -530,10 +524,11 @@ where
     /// use papaya::HashMap;
     ///
     /// let map = HashMap::new();
-    /// let m = map.pin();
-    /// assert_eq!(m.try_insert(37, "a").unwrap(), &"a");
+    /// let map = map.pin();
+    ///
+    /// assert_eq!(map.try_insert(37, "a").unwrap(), &"a");
     ///
-    /// let err = m.try_insert(37, "b").unwrap_err();
+    /// let err = map.try_insert(37, "b").unwrap_err();
     /// assert_eq!(err.current, &"a");
     /// assert_eq!(err.not_inserted, "b");
     /// ```

src/set.rs

@@ -359,10 +359,9 @@ where
     /// use papaya::HashSet;
     ///
     /// let set = HashSet::new();
-    /// let m = set.pin();
-    /// m.insert(1);
-    /// assert_eq!(m.contains(&1), true);
-    /// assert_eq!(m.contains(&2), false);
+    /// set.pin().insert(1);
+    /// assert_eq!(set.pin().contains(&1), true);
+    /// assert_eq!(set.pin().contains(&2), false);
     /// ```
     #[inline]
     pub fn contains<Q>(&self, key: &Q, guard: &impl Guard) -> bool
@@ -388,10 +387,9 @@ where
     /// use papaya::HashSet;
     ///
     /// let set = HashSet::new();
-    /// let m = set.pin();
-    /// m.insert(1);
-    /// assert_eq!(m.get(&1), Some(&1));
-    /// assert_eq!(m.get(&2), None);
+    /// set.pin().insert(1);
+    /// assert_eq!(set.pin().get(&1), Some(&1));
+    /// assert_eq!(set.pin().get(&2), None);
     /// ```
     #[inline]
     pub fn get<'g, Q>(&self, key: &Q, guard: &'g impl Guard) -> Option<&'g K>
@@ -428,12 +426,9 @@ where
     /// assert_eq!(set.pin().insert(37), true);
     /// assert_eq!(set.pin().is_empty(), false);
     ///
-    /// // note: you can also re-use a set pin like so:
-    /// let m = set.pin();
-    ///
-    /// m.insert(37);
-    /// assert_eq!(m.insert(37), false);
-    /// assert_eq!(m.get(&37), Some(&37));
+    /// set.pin().insert(37);
+    /// assert_eq!(set.pin().insert(37), false);
+    /// assert_eq!(set.pin().get(&37), Some(&37));
     /// ```
     #[inline]
     pub fn insert(&self, key: K, guard: &impl Guard) -> bool {