mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #77874 - camelid:range-docs-readability, r=scottmcm

Browse Source 
Improve range docs

* Improve code formatting and legibility
* Various other readability improvements
This commit is contained in:
bors 2020-10-19 00:11:08 +00:00
commit e42cbe8edc
1 changed files with 52 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
library/core/src/ops/range.rs
View File

@ -31,12 +31,12 @@ use crate::slice::index::{
/// ///
/// ``` /// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); // RangeFull /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]); // This is the `RangeFull`
/// assert_eq!(arr[ .. 3], [0,1,2 ]); /// assert_eq!(arr[ .. 3], [0, 1, 2 ]);
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]);
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]);
/// assert_eq!(arr[1.. 3], [ 1,2 ]); /// assert_eq!(arr[1.. 3], [ 1, 2 ]);
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]);
/// ``` /// ```
/// ///
/// [slicing index]: crate::slice::SliceIndex /// [slicing index]: crate::slice::SliceIndex
@ -56,22 +56,26 @@ impl fmt::Debug for RangeFull {
/// A (half-open) range bounded inclusively below and exclusively above /// A (half-open) range bounded inclusively below and exclusively above
/// (`start..end`). /// (`start..end`).
/// ///
/// The `Range` `start..end` contains all values with `x >= start` and /// The range `start..end` contains all values with `start <= x < end`.
/// `x < end`. It is empty unless `start < end`. /// It is empty if `start >= end`.
/// ///
/// # Examples /// # Examples
/// ///
/// The `start..end` syntax is a `Range`:
///
/// ``` /// ```
/// assert_eq!((3..5), std::ops::Range { start: 3, end: 5 }); /// assert_eq!((3..5), std::ops::Range { start: 3, end: 5 });
/// assert_eq!(3 + 4 + 5, (3..6).sum()); /// assert_eq!(3 + 4 + 5, (3..6).sum());
/// ```
/// ///
/// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]);
/// assert_eq!(arr[ .. 3], [0,1,2 ]); /// assert_eq!(arr[ .. 3], [0, 1, 2 ]);
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]);
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]);
/// assert_eq!(arr[1.. 3], [ 1,2 ]); // Range /// assert_eq!(arr[1.. 3], [ 1, 2 ]); // This is a `Range`
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]);
/// ``` /// ```
#[lang = "Range"] #[lang = "Range"]
#[doc(alias = "..")] #[doc(alias = "..")]
@ -164,17 +168,21 @@ impl<Idx: PartialOrd<Idx>> Range<Idx> {
/// ///
/// # Examples /// # Examples
/// ///
/// The `start..` syntax is a `RangeFrom`:
///
/// ``` /// ```
/// assert_eq!((2..), std::ops::RangeFrom { start: 2 }); /// assert_eq!((2..), std::ops::RangeFrom { start: 2 });
/// assert_eq!(2 + 3 + 4, (2..).take(3).sum()); /// assert_eq!(2 + 3 + 4, (2..).take(3).sum());
/// ```
/// ///
/// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]);
/// assert_eq!(arr[ .. 3], [0,1,2 ]); /// assert_eq!(arr[ .. 3], [0, 1, 2 ]);
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]);
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); // RangeFrom /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]); // This is a `RangeFrom`
/// assert_eq!(arr[1.. 3], [ 1,2 ]); /// assert_eq!(arr[1.. 3], [ 1, 2 ]);
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]);
/// ``` /// ```
#[lang = "RangeFrom"] #[lang = "RangeFrom"]
#[doc(alias = "..")] #[doc(alias = "..")]
@ -248,12 +256,12 @@ impl<Idx: PartialOrd<Idx>> RangeFrom<Idx> {
/// ///
/// ``` /// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]);
/// assert_eq!(arr[ .. 3], [0,1,2 ]); // RangeTo /// assert_eq!(arr[ .. 3], [0, 1, 2 ]); // This is a `RangeTo`
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]);
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]);
/// assert_eq!(arr[1.. 3], [ 1,2 ]); /// assert_eq!(arr[1.. 3], [ 1, 2 ]);
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]);
/// ``` /// ```
/// ///
/// [slicing index]: crate::slice::SliceIndex /// [slicing index]: crate::slice::SliceIndex
@ -314,17 +322,21 @@ impl<Idx: PartialOrd<Idx>> RangeTo<Idx> {
/// ///
/// # Examples /// # Examples
/// ///
/// The `start..=end` syntax is a `RangeInclusive`:
///
/// ``` /// ```
/// assert_eq!((3..=5), std::ops::RangeInclusive::new(3, 5)); /// assert_eq!((3..=5), std::ops::RangeInclusive::new(3, 5));
/// assert_eq!(3 + 4 + 5, (3..=5).sum()); /// assert_eq!(3 + 4 + 5, (3..=5).sum());
/// ```
/// ///
/// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]);
/// assert_eq!(arr[ .. 3], [0,1,2 ]); /// assert_eq!(arr[ .. 3], [0, 1, 2 ]);
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]);
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]);
/// assert_eq!(arr[1.. 3], [ 1,2 ]); /// assert_eq!(arr[1.. 3], [ 1, 2 ]);
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); // RangeInclusive /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]); // This is a `RangeInclusive`
/// ``` /// ```
#[lang = "RangeInclusive"] #[lang = "RangeInclusive"]
#[doc(alias = "..=")] #[doc(alias = "..=")]
@ -538,12 +550,12 @@ impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx> {
/// ///
/// ``` /// ```
/// let arr = [0, 1, 2, 3, 4]; /// let arr = [0, 1, 2, 3, 4];
/// assert_eq!(arr[ .. ], [0,1,2,3,4]); /// assert_eq!(arr[ .. ], [0, 1, 2, 3, 4]);
/// assert_eq!(arr[ .. 3], [0,1,2 ]); /// assert_eq!(arr[ .. 3], [0, 1, 2 ]);
/// assert_eq!(arr[ ..=3], [0,1,2,3 ]); // RangeToInclusive /// assert_eq!(arr[ ..=3], [0, 1, 2, 3 ]); // This is a `RangeToInclusive`
/// assert_eq!(arr[1.. ], [ 1,2,3,4]); /// assert_eq!(arr[1.. ], [ 1, 2, 3, 4]);
/// assert_eq!(arr[1.. 3], [ 1,2 ]); /// assert_eq!(arr[1.. 3], [ 1, 2 ]);
/// assert_eq!(arr[1..=3], [ 1,2,3 ]); /// assert_eq!(arr[1..=3], [ 1, 2, 3 ]);
/// ``` /// ```
/// ///
/// [slicing index]: crate::slice::SliceIndex /// [slicing index]: crate::slice::SliceIndex
@ -665,9 +677,9 @@ impl<T: Clone> Bound<&T> {
} }
} }
#[stable(feature = "collections_range", since = "1.28.0")]
/// `RangeBounds` is implemented by Rust's built-in range types, produced /// `RangeBounds` is implemented by Rust's built-in range types, produced
/// by range syntax like `..`, `a..`, `..b`, `..=c`, `d..e`, or `f..=g`. /// by range syntax like `..`, `a..`, `..b`, `..=c`, `d..e`, or `f..=g`.
#[stable(feature = "collections_range", since = "1.28.0")]
pub trait RangeBounds<T: ?Sized> { pub trait RangeBounds<T: ?Sized> {
/// Start index bound. /// Start index bound.
/// ///