Apply suggestion from review

[rust.git] / src / liballoc / vec.rs

diff --git a/src/liballoc/vec.rs b/src/liballoc/vec.rs
index 269eeed3ccf8608ec0c2f9acb3656efead38c143..2f56898f4e9b66e43823aa765140932a0e082028 100644 (file)
--- a/src/liballoc/vec.rs
+++ b/src/liballoc/vec.rs
@@ -1274,12 +1274,10 @@ unsafe fn append_elements(&mut self, other: *const [T]) {
     /// Creates a draining iterator that removes the specified range in the vector
     /// and yields the removed items.
     ///
-    /// The element range is removed even if the iterator is only partially
-    /// consumed or not consumed at all.
-    ///
-    /// Note: Be aware that if the iterator is leaked (eg: [`mem::forget`]), it
-    /// cancels this property so it is unspecified how many elements are removed
-    /// from the vector in this case.
+    /// When the iterator **is** dropped, all elements in the range are removed
+    /// from the vector, even if the iterator was not fully consumed. If the
+    /// iterator **is not** dropped (with [`mem::forget`] for example), it is
+    /// unspecified how many elements are removed.
     ///
     /// # Panics
     ///
@@ -1298,8 +1296,6 @@ unsafe fn append_elements(&mut self, other: *const [T]) {
     /// v.drain(..);
     /// assert_eq!(v, &[]);
     /// ```
-    ///
-    /// [`mem::forget`]: mem::forget
     #[stable(feature = "drain", since = "1.6.0")]
     pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>
     where