mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #66094 - ArturKovacs:fix-count-doc, r=Dylan-DPC

Browse Source 
Fix documentation for `Iterator::count()`.

The documentation of std::core::Iterator::count() stated that the number returned is the number of times `next` is called on the iterator. However this is not true as the number of times `next` is called is exactly one plus the number returned by `count()`.
This commit is contained in:
Yuki Okushi 2019-11-13 22:09:11 +09:00 committed by GitHub
commit e365d5aac6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/libcore/iter/traits/iterator.rs
View File

@ -201,12 +201,13 @@ pub trait Iterator {
/// Consumes the iterator, counting the number of iterations and returning it. /// Consumes the iterator, counting the number of iterations and returning it.
/// ///
/// This method will evaluate the iterator until its [`next`] returns /// This method will call [`next`] repeatedly until [`None`] is encountered,
/// [`None`]. Once [`None`] is encountered, `count()` returns the number of /// returning the number of times it saw [`Some`]. Note that [`next`] has to be
/// times it called [`next`]. /// called at least once even if the iterator does not have any elements.
/// ///
/// [`next`]: #tymethod.next /// [`next`]: #tymethod.next
/// [`None`]: ../../std/option/enum.Option.html#variant.None /// [`None`]: ../../std/option/enum.Option.html#variant.None
/// [`Some`]: ../../std/option/enum.Option.html#variant.Some
/// ///
/// # Overflow Behavior /// # Overflow Behavior
/// ///