]> git.lizzy.rs Git - rust.git/commitdiff
document DoubleEndedIterator::next_back
authorAlex Burka <durka42+github@gmail.com>
Sat, 9 Jul 2016 03:14:32 +0000 (23:14 -0400)
committerGitHub <noreply@github.com>
Sat, 9 Jul 2016 03:14:32 +0000 (23:14 -0400)
fixes #34726

src/libcore/iter/traits.rs

index 9b5c2128f1eaf9fd59460d6fc432794f0a05fc26..43360b91fdaaab5b349cc9de855ee9e2f89c7347 100644 (file)
@@ -386,10 +386,11 @@ pub trait Extend<A> {
 /// ```
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait DoubleEndedIterator: Iterator {
-    /// An iterator able to yield elements from both ends.
+    /// Removes and returns an element from the end of the iterator.
     ///
-    /// As this is the only method for this trait, the [trait-level] docs
-    /// contain more details.
+    /// Returns `None` when there are no more elements.
+    ///
+    /// The [trait-level] docs contain more details.
     ///
     /// [trait-level]: trait.DoubleEndedIterator.html
     ///