about summary refs log tree commit diff
path: root/library/alloc/src/vec
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-03-11 03:32:06 +0100
committerGitHub <noreply@github.com>2022-03-11 03:32:06 +0100
commitf97a1c6909f2786564bcff9270fc9eef9d0a5d2f (patch)
tree170e71eb3637996ced89f65917256fb530278cc1 /library/alloc/src/vec
parentbb8274ad36db4fba178959da68a903894d0e7a86 (diff)
parent229e01d11fc5e6e34488beb5da05702de5eac632 (diff)
downloadrust-f97a1c6909f2786564bcff9270fc9eef9d0a5d2f.tar.gz
rust-f97a1c6909f2786564bcff9270fc9eef9d0a5d2f.zip
Rollup merge of #94826 - allgoewer:fix-retain-documentation, r=yaahc
Improve doc wording for retain on some collections

I found the documentation wording on the various retain methods on many collections to be unusual.
I tried to invert the relation by switching `such that` with `for which` .
Diffstat (limited to 'library/alloc/src/vec')
-rw-r--r--library/alloc/src/vec/mod.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs
index 32590a2996c..5131168db0c 100644
--- a/library/alloc/src/vec/mod.rs
+++ b/library/alloc/src/vec/mod.rs
@@ -1424,7 +1424,7 @@ impl<T, A: Allocator> Vec<T, A> {
 
     /// Retains only the elements specified by the predicate.
     ///
-    /// In other words, remove all elements `e` such that `f(&e)` returns `false`.
+    /// In other words, remove all elements `e` for which `f(&e)` returns `false`.
     /// This method operates in place, visiting each element exactly once in the
     /// original order, and preserves the order of the retained elements.
     ///