Rollup merge of #48438 - mbrubeck:docs, r=TimNN

[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.
This commit is contained in:
Manish Goregaokar 2018-02-23 10:24:56 -08:00 committed by GitHub
commit f2cbb764b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions

View File

@ -747,8 +747,8 @@ impl<T> LinkedList<T> {
/// Creates an iterator which uses a closure to determine if an element should be removed. /// 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 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, /// If the closure returns false, the element will remain in the list and will not be yielded
/// seeing if it passes the test. /// by the iterator.
/// ///
/// Note that `drain_filter` lets you mutate every element in the filter closure, regardless of /// Note that `drain_filter` lets you mutate every element in the filter closure, regardless of
/// whether you choose to keep or remove it. /// whether you choose to keep or remove it.

View File

@ -1966,8 +1966,8 @@ impl<T> Vec<T> {
/// Creates an iterator which uses a closure to determine if an element should be removed. /// 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 true, then the element is removed and yielded.
/// If the closure returns false, it will try again, and call the closure /// If the closure returns false, the element will remain in the vector and will not be yielded
/// on the next element, seeing if it passes the test. /// by the iterator.
/// ///
/// Using this method is equivalent to the following code: /// Using this method is equivalent to the following code:
/// ///