about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTshepang Lekhonkhobe <tshepang@gmail.com>2016-10-21 00:15:07 +0200
committerTshepang Lekhonkhobe <tshepang@gmail.com>2016-10-21 00:38:00 +0200
commit3e26a93a36ccf5239ed5102bcc66bb72d3bc9251 (patch)
tree707281abcea9eed43af606b5f3e936ab5aa37b4f
parent7bccb829d0fe9a733bd6efcf6f7313186ae237ab (diff)
downloadrust-3e26a93a36ccf5239ed5102bcc66bb72d3bc9251.tar.gz
rust-3e26a93a36ccf5239ed5102bcc66bb72d3bc9251.zip
doc: a more simple description of Iterator::nth
-rw-r--r--src/libcore/iter/iterator.rs8
1 files changed, 2 insertions, 6 deletions
diff --git a/src/libcore/iter/iterator.rs b/src/libcore/iter/iterator.rs
index 0e74bbe9c26..5a12f5db19d 100644
--- a/src/libcore/iter/iterator.rs
+++ b/src/libcore/iter/iterator.rs
@@ -195,13 +195,9 @@ pub trait Iterator {
         last
     }
 
-    /// Consumes the `n` first elements of the iterator, then returns the
-    /// `next()` one.
+    /// Returns the `n`th element of the iterator.
     ///
-    /// This method will evaluate the iterator `n` times, discarding those elements.
-    /// After it does so, it will call [`next()`] and return its value.
-    ///
-    /// [`next()`]: #tymethod.next
+    /// Note that all preceding elements will be consumed (i.e. discarded).
     ///
     /// Like most indexing operations, the count starts from zero, so `nth(0)`
     /// returns the first value, `nth(1)` the second, and so on.