about summary refs log tree commit diff
diff options
context:
space:
mode:
authorpierwill <19642016+pierwill@users.noreply.github.com>2022-07-21 08:49:53 -0500
committerpierwill <pierwill@users.noreply.github.com>2022-07-21 08:52:18 -0500
commitaad1aa34085b2d4a6a2bf926c2ba1e3f294dd0f7 (patch)
treebaf81062fe023000969d51033b9b82635323f107
parent74f600b990240556c9a355c5d03293a10934bd1b (diff)
downloadrust-aad1aa34085b2d4a6a2bf926c2ba1e3f294dd0f7.tar.gz
rust-aad1aa34085b2d4a6a2bf926c2ba1e3f294dd0f7.zip
Edit `rustc_index::vec::IndexVec::pick3_mut` docs
Clarify when this method will panic.

Also fix formatting for `pick2_mut`.
-rw-r--r--compiler/rustc_index/src/vec.rs8
1 files changed, 6 insertions, 2 deletions
diff --git a/compiler/rustc_index/src/vec.rs b/compiler/rustc_index/src/vec.rs
index 1a55519d7b1..30ff364210d 100644
--- a/compiler/rustc_index/src/vec.rs
+++ b/compiler/rustc_index/src/vec.rs
@@ -234,7 +234,9 @@ impl<I: Idx, T> IndexVec<I, T> {
         self.raw.get_mut(index.index())
     }
 
-    /// Returns mutable references to two distinct elements, a and b. Panics if a == b.
+    /// Returns mutable references to two distinct elements, `a` and `b`.
+    ///
+    /// Panics if `a == b`.
     #[inline]
     pub fn pick2_mut(&mut self, a: I, b: I) -> (&mut T, &mut T) {
         let (ai, bi) = (a.index(), b.index());
@@ -249,7 +251,9 @@ impl<I: Idx, T> IndexVec<I, T> {
         }
     }
 
-    /// Returns mutable references to three distinct elements or panics otherwise.
+    /// Returns mutable references to three distinct elements.
+    ///
+    /// Panics if the elements are not distinct.
     #[inline]
     pub fn pick3_mut(&mut self, a: I, b: I, c: I) -> (&mut T, &mut T, &mut T) {
         let (ai, bi, ci) = (a.index(), b.index(), c.index());