Docs and minor style change for Arena::get2_mut

LPGhatguy · Feb 11, 2021 · 356ab82 · 356ab82
1 parent 3b1f880
commit 356ab82
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Unreleased Changes
 * Implemented `IntoIterator` for `&Arena` and `&mut Arena`.
+* Added `Arena::get2_mut` for getting two mutable references of different slots at once.
 
 ## 0.4.0 (2020-11-17)
 * Added `Index::slot` for extracting the slot portion of an index.

diff --git a/src/arena.rs b/src/arena.rs
@@ -221,9 +221,9 @@ impl<T> Arena<T> {
         }
     }
 
-    /// Get mutable references to two values inside this arena at once by
-    /// [`Index`], returning `None` if the corresponding index is not contained
-    /// in this arena.
+    /// Get mutable references of two values inside this arena at once by
+    /// [`Index`], returning `None` if the corresponding `index` is not 
+    /// contained in this arena.
     ///
     /// # Panics
     ///
@@ -234,7 +234,8 @@ impl<T> Arena<T> {
             panic!("Arena::get2_mut is called with two identical indices");
         }
 
-        // Unsafe notes:
+        // SAFETY NOTES:
+        // 
         // - If `index1` and `index2` have different slot number, `item1` and
         //   `item2` would point to different elements.
         // - If `index1` and `index2` have the same slot number, only one could