bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #88273 - jhpratt:update-iterator-docs, r=jyn514

Browse source 
Fix references to `ControlFlow` in docs

The `Iterator::for_each` method previously stated that it was not possible to use `break` and `continue` in it — this has been updated to acknowledge the stabilization of `ControlFlow`. Additionally, `ControlFlow` was referred to as `crate::ops::ControlFlow` which is not the correct path for an end user.

r? `@jyn514`
This commit is contained in:
Léo Lanteri Thauvin 2021-08-25 15:48:55 +02:00 • committed by GitHub
commit 3375283763
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
library/core/src/iter/traits/iterator.rs
View file

@ -1957,8 +1957,8 @@ pub trait Iterator {
/// assert_eq!(it.next(), Some(&40)); /// assert_eq!(it.next(), Some(&40));
/// ``` /// ```
/// ///
/// While you cannot `break` from a closure, the [`crate::ops::ControlFlow`] /// While you cannot `break` from a closure, the [`ControlFlow`] type allows
/// type allows a similar idea: /// a similar idea:
/// ///
/// ``` /// ```
/// use std::ops::ControlFlow; /// use std::ops::ControlFlow;
@ -2024,8 +2024,8 @@ pub trait Iterator {
/// assert_eq!(it.next(), Some("stale_bread.json")); /// assert_eq!(it.next(), Some("stale_bread.json"));
/// ``` /// ```
/// ///
/// The [`crate::ops::ControlFlow`] type can be used with this method for the /// The [`ControlFlow`] type can be used with this method for the situations
/// situations in which you'd use `break` and `continue` in a normal loop: /// in which you'd use `break` and `continue` in a normal loop:
/// ///
/// ``` /// ```
/// use std::ops::ControlFlow; /// use std::ops::ControlFlow;