]> git.lizzy.rs Git - rust.git/commitdiff
Apply suggestion from review
authorAlexis Bourget <alexis.bourget@gmail.com>
Fri, 24 Jul 2020 17:55:08 +0000 (19:55 +0200)
committerAlexis Bourget <alexis.bourget@gmail.com>
Fri, 24 Jul 2020 17:55:08 +0000 (19:55 +0200)
src/liballoc/vec.rs

index 30ff28f3fdb140614bd482cc46f2b92032f39d2f..2f56898f4e9b66e43823aa765140932a0e082028 100644 (file)
@@ -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
     ///