From 7550b618f9489f7e7f7c4659beef6f0070ad8b19 Mon Sep 17 00:00:00 2001 From: Artur Kovacs Date: Mon, 4 Nov 2019 19:37:37 +0100 Subject: [PATCH] Fix documentation for `Iterator::count()`. --- src/libcore/iter/traits/iterator.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/libcore/iter/traits/iterator.rs b/src/libcore/iter/traits/iterator.rs index 7ffc8b3729cb..90535a647ccc 100644 --- a/src/libcore/iter/traits/iterator.rs +++ b/src/libcore/iter/traits/iterator.rs @@ -202,8 +202,9 @@ pub trait Iterator { /// Consumes the iterator, counting the number of iterations and returning it. /// /// This method will evaluate the iterator until its [`next`] returns - /// [`None`]. Once [`None`] is encountered, `count()` returns the number of - /// times it called [`next`]. + /// [`None`]. Once [`None`] is encountered, `count()` returns one less than the + /// number of times it called [`next`]. Note that [`next`] has to be called at + /// least once even if the iterator does not have any elements. /// /// [`next`]: #tymethod.next /// [`None`]: ../../std/option/enum.Option.html#variant.None