about summary refs log tree commit diff
path: root/src/liballoc/vec.rs
diff options
context:
space:
mode:
authorMatt Brubeck <mbrubeck@limpet.net>2018-02-22 12:05:30 -0800
committerMatt Brubeck <mbrubeck@limpet.net>2018-02-22 12:05:30 -0800
commit311fbc9265ea1ebe803449c8d7e083f9edf605d9 (patch)
tree96d68c77530464628d3ffe6d89b39deb413e7285 /src/liballoc/vec.rs
parentb1f8e6fb06d7362eeb2065347a7db94e76b1cb2f (diff)
downloadrust-311fbc9265ea1ebe803449c8d7e083f9edf605d9.tar.gz
rust-311fbc9265ea1ebe803449c8d7e083f9edf605d9.zip
[docs] Minor wording changes to drain_filter docs
The docs currently say, "If the closure returns false, it will try
again, and call the closure on the next element."  But this happens
regardless of whether the closure returns true or false.
Diffstat (limited to 'src/liballoc/vec.rs')
-rw-r--r--src/liballoc/vec.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/liballoc/vec.rs b/src/liballoc/vec.rs
index 39a4d271bd6..3c9b6b94b44 100644
--- a/src/liballoc/vec.rs
+++ b/src/liballoc/vec.rs
@@ -1966,8 +1966,8 @@ impl<T> Vec<T> {
     /// Creates an iterator which uses a closure to determine if an element should be removed.
     ///
     /// If the closure returns true, then the element is removed and yielded.
-    /// If the closure returns false, it will try again, and call the closure
-    /// on the next element, seeing if it passes the test.
+    /// If the closure returns false, the element will remain in the vector and will not be yielded
+    /// by the iterator.
     ///
     /// Using this method is equivalent to the following code:
     ///