about summary refs log tree commit diff
diff options
context:
space:
mode:
authorYuki Okushi <jtitor@2k36.org>2021-11-30 17:29:13 +0900
committerGitHub <noreply@github.com>2021-11-30 17:29:13 +0900
commit28176a4a33dfa04b63d5494a0726be8befc4dcb9 (patch)
tree48f726fe439aa5f29d602672e812405874c99fd3
parent898f1e47173bbc069ec1f78364cd3c029c61c139 (diff)
parentdea3494b3122e950d91cb5f387ff6dcdac8e2ab6 (diff)
downloadrust-28176a4a33dfa04b63d5494a0726be8befc4dcb9.tar.gz
rust-28176a4a33dfa04b63d5494a0726be8befc4dcb9.zip
Rollup merge of #91383 - ScriptDevil:drop-while-doc-alias, r=joshtriplett
Add `drop_while` as doc alias to `Iterator::skip_while`

`skip_while` is commonly referred to as `drop_while` in other languages (clojure/c++/haskell). This recently came up in [Zulip](https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/.E2.9C.94.20DropWhile/near/262203352) as well.

This pull request adds 'drop_while' as a doc-alias for 'skip_while'.

r? `@joshtriplett`
-rw-r--r--library/core/src/iter/traits/iterator.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/library/core/src/iter/traits/iterator.rs b/library/core/src/iter/traits/iterator.rs
index f3ef6b3d018..35ce9400f8f 100644
--- a/library/core/src/iter/traits/iterator.rs
+++ b/library/core/src/iter/traits/iterator.rs
@@ -1023,6 +1023,7 @@ pub trait Iterator {
     /// assert_eq!(iter.next(), None);
     /// ```
     #[inline]
+    #[doc(alias = "drop_while")]
     #[stable(feature = "rust1", since = "1.0.0")]
     fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
     where