doc: a more simple description of Iterator::nth

This commit is contained in:
Tshepang Lekhonkhobe 2016-10-21 00:15:07 +02:00
parent 7bccb829d0
commit 3e26a93a36
1 changed files with 2 additions and 6 deletions

View File

@ -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.