From 11d36aec8317dba64e30b98aad75c70e4eed6b3e Mon Sep 17 00:00:00 2001 From: Rob Speer Date: Fri, 10 Feb 2017 01:35:29 -0500 Subject: [PATCH] iterator docs: Move paragraph about discarding; clarify "consumed" --- src/libcore/iter/iterator.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/libcore/iter/iterator.rs b/src/libcore/iter/iterator.rs index 4a8c8b53a8c2..d41767cce18f 100644 --- a/src/libcore/iter/iterator.rs +++ b/src/libcore/iter/iterator.rs @@ -209,14 +209,14 @@ pub trait Iterator { /// Returns the `n`th element of the iterator. /// - /// Note that all preceding elements, as well as the returned element, will be - /// consumed. That means that the preceding elements will be discarded, and also - /// that calling `nth(0)` multiple times on the same iterator will return different - /// elements. - /// /// Like most indexing operations, the count starts from zero, so `nth(0)` /// returns the first value, `nth(1)` the second, and so on. /// + /// Note that all preceding elements, as well as the returned element, will be + /// consumed from the iterator. That means that the preceding elements will be + /// discarded, and also that calling `nth(0)` multiple times on the same iterator + /// will return different elements. + /// /// `nth()` will return [`None`] if `n` is greater than or equal to the length of the /// iterator. ///