about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2016-08-05 16:12:53 +0200
committerGitHub <noreply@github.com>2016-08-05 16:12:53 +0200
commit5afe7bbeea9c609bef7d8661b0e8d64f24e6a176 (patch)
tree165f4aab2b43ad4f94d4ddc8dccdc54211ec16ed
parent1bb555257fd6c400870743b50bc479175926fae6 (diff)
parent727d9293e47b349c500d34f887e43051d865de4d (diff)
downloadrust-5afe7bbeea9c609bef7d8661b0e8d64f24e6a176.tar.gz
rust-5afe7bbeea9c609bef7d8661b0e8d64f24e6a176.zip
Rollup merge of #35041 - frewsxcv:range-rangeargument, r=GuillaumeGomez
Add doc examples for `range::RangeArgument::{start,end}`.

None
-rw-r--r--src/libcollections/range.rs32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/libcollections/range.rs b/src/libcollections/range.rs
index 4e39191b472..1badc72aed0 100644
--- a/src/libcollections/range.rs
+++ b/src/libcollections/range.rs
@@ -23,6 +23,22 @@ pub trait RangeArgument<T> {
     /// Start index (inclusive)
     ///
     /// Return start value if present, else `None`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// #![feature(collections)]
+    /// #![feature(collections_range)]
+    ///
+    /// extern crate collections;
+    ///
+    /// # fn main() {
+    /// use collections::range::RangeArgument;
+    ///
+    /// assert_eq!((..10).start(), None);
+    /// assert_eq!((3..10).start(), Some(&3));
+    /// # }
+    /// ```
     fn start(&self) -> Option<&T> {
         None
     }
@@ -30,6 +46,22 @@ pub trait RangeArgument<T> {
     /// End index (exclusive)
     ///
     /// Return end value if present, else `None`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// #![feature(collections)]
+    /// #![feature(collections_range)]
+    ///
+    /// extern crate collections;
+    ///
+    /// # fn main() {
+    /// use collections::range::RangeArgument;
+    ///
+    /// assert_eq!((3..).end(), None);
+    /// assert_eq!((3..10).end(), Some(&10));
+    /// # }
+    /// ```
     fn end(&self) -> Option<&T> {
         None
     }