From: Manuel <LifeIsHealthy@icloud.com>
Date: Tue, 21 Mar 2017 21:18:52 +0000 (+0100)
Subject: Fix doc error for ExactSizeIterator
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=a8800bb675397e6aa06ffdac46092d5d03e0cf69;p=rust.git

Fix doc error for ExactSizeIterator

The code example in the trait documentation of ExactSizeIterator
has an incorrect implementation of the len method that does not return
the number of times the example iterator 'Counter' will iterate. This
may confuse readers of the docs as the example code will compile but
doesn't uphold the trait's contract.

This is easily fixed by modifying the implementation of len and changing
the assert statement to actually assert the correct behaviour. I also
slightly modified a code comment to better reflect what the method
returns.
---

diff --git a/src/libcore/iter/traits.rs b/src/libcore/iter/traits.rs
index 3415b0eea9b..34f14ef53f8 100644
--- a/src/libcore/iter/traits.rs
+++ b/src/libcore/iter/traits.rs
@@ -536,9 +536,9 @@ fn next_back(&mut self) -> Option<I::Item> { (**self).next_back() }
 /// #     }
 /// # }
 /// impl ExactSizeIterator for Counter {
-///     // We already have the number of iterations, so we can use it directly.
+///     // We can easily calculate the remaining number of iterations.
 ///     fn len(&self) -> usize {
-///         self.count
+///         5 - self.count
 ///     }
 /// }
 ///
@@ -546,7 +546,7 @@ fn next_back(&mut self) -> Option<I::Item> { (**self).next_back() }
 ///
 /// let counter = Counter::new();
 ///
-/// assert_eq!(0, counter.len());
+/// assert_eq!(5, counter.len());
 /// ```
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait ExactSizeIterator: Iterator {