diff options
author | Corey Farwell <coreyf@rwell.org> | 2017-01-17 21:59:26 -0500 |
---|---|---|
committer | Corey Farwell <coreyf@rwell.org> | 2017-01-18 08:36:32 -0500 |
commit | 81acd4806ef7ea755f7f33f8ac5f805ce37ba8df (patch) | |
tree | 6aaf1eab904477a1246c9ad6d24f8cddcb7e098c | |
parent | c8af93f0901c336e873ce18274026d0fd9bc7c1f (diff) | |
download | rust-slice.tar.gz |
A few improvements to the slice docs.slice
* Simplify `Option::iter_mut` doc example.
* Document 'empty' corner-cases for `slice::{starts_with, ends_with}`.
* Indicate 'true' as code-like.
-rw-r--r-- | src/libcollections/slice.rs | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/src/libcollections/slice.rs b/src/libcollections/slice.rs index 805021516db..f026d1d0f57 100644 --- a/src/libcollections/slice.rs +++ b/src/libcollections/slice.rs @@ -181,7 +181,7 @@ impl<T> [T] { core_slice::SliceExt::len(self) } - /// Returns true if the slice has a length of 0. + /// Returns `true` if the slice has a length of 0. /// /// # Example /// @@ -540,14 +540,10 @@ impl<T> [T] { /// /// ``` /// let x = &mut [1, 2, 4]; - /// { - /// let iterator = x.iter_mut(); - /// - /// for elem in iterator { - /// *elem += 2; - /// } + /// for elem in x.iter_mut() { + /// *elem += 2; /// } - /// assert_eq!(x, &[3, 4, 6]); + /// assert_eq!(x, [3, 4, 6]); /// ``` #[stable(feature = "rust1", since = "1.0.0")] #[inline] @@ -880,7 +876,7 @@ impl<T> [T] { core_slice::SliceExt::rsplitn_mut(self, n, pred) } - /// Returns true if the slice contains an element with the given value. + /// Returns `true` if the slice contains an element with the given value. /// /// # Examples /// @@ -896,7 +892,7 @@ impl<T> [T] { core_slice::SliceExt::contains(self, x) } - /// Returns true if `needle` is a prefix of the slice. + /// Returns `true` if `needle` is a prefix of the slice. /// /// # Examples /// @@ -907,6 +903,15 @@ impl<T> [T] { /// assert!(!v.starts_with(&[50])); /// assert!(!v.starts_with(&[10, 50])); /// ``` + /// + /// Always returns `true` if `needle` is an empty slice: + /// + /// ``` + /// let v = [10, 40, 30]; + /// assert!(v.starts_with(&[])); + /// let v: [u8] = []; + /// assert!(v.starts_with(&[])); + /// ``` #[stable(feature = "rust1", since = "1.0.0")] pub fn starts_with(&self, needle: &[T]) -> bool where T: PartialEq @@ -914,7 +919,7 @@ impl<T> [T] { core_slice::SliceExt::starts_with(self, needle) } - /// Returns true if `needle` is a suffix of the slice. + /// Returns `true` if `needle` is a suffix of the slice. /// /// # Examples /// @@ -925,6 +930,15 @@ impl<T> [T] { /// assert!(!v.ends_with(&[50])); /// assert!(!v.ends_with(&[50, 30])); /// ``` + /// + /// Always returns `true` if `needle` is an empty slice: + /// + /// ``` + /// let v = [10, 40, 30]; + /// assert!(v.ends_with(&[])); + /// let v: [u8] = []; + /// assert!(v.ends_with(&[])); + /// ``` #[stable(feature = "rust1", since = "1.0.0")] pub fn ends_with(&self, needle: &[T]) -> bool where T: PartialEq |