nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 23:04:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #110448 - ripytide:master, r=cuviper

Browse Source 
cmp doc examples improvements

Most changes are for stylistic consistency, with some changes to provide more clarity.
This commit is contained in:
Yuki Okushi 2023-04-20 17:03:24 +09:00 committed by GitHub
commit 9dbd25c705
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
library/core/src/cmp.rs
View File

@ -321,14 +321,11 @@ pub struct AssertParamIsEq<T: Eq + ?Sized> {
/// ``` /// ```
/// use std::cmp::Ordering; /// use std::cmp::Ordering;
/// ///
/// let result = 1.cmp(&2); /// assert_eq!(1.cmp(&2), Ordering::Less);
/// assert_eq!(Ordering::Less, result);
/// ///
/// let result = 1.cmp(&1); /// assert_eq!(1.cmp(&1), Ordering::Equal);
/// assert_eq!(Ordering::Equal, result);
/// ///
/// let result = 2.cmp(&1); /// assert_eq!(2.cmp(&1), Ordering::Greater);
/// assert_eq!(Ordering::Greater, result);
/// ``` /// ```
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)] #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
@ -784,8 +781,8 @@ pub trait Ord: Eq + PartialOrd<Self> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// assert_eq!(2, 1.max(2)); /// assert_eq!(1.max(2), 2);
/// assert_eq!(2, 2.max(2)); /// assert_eq!(2.max(2), 2);
/// ``` /// ```
#[stable(feature = "ord_max_min", since = "1.21.0")] #[stable(feature = "ord_max_min", since = "1.21.0")]
#[inline] #[inline]
@ -804,8 +801,8 @@ pub trait Ord: Eq + PartialOrd<Self> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// assert_eq!(1, 1.min(2)); /// assert_eq!(1.min(2), 1);
/// assert_eq!(2, 2.min(2)); /// assert_eq!(2.min(2), 2);
/// ``` /// ```
#[stable(feature = "ord_max_min", since = "1.21.0")] #[stable(feature = "ord_max_min", since = "1.21.0")]
#[inline] #[inline]
@ -829,9 +826,9 @@ pub trait Ord: Eq + PartialOrd<Self> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// assert!((-3).clamp(-2, 1) == -2); /// assert_eq!((-3).clamp(-2, 1), -2);
/// assert!(0.clamp(-2, 1) == 0); /// assert_eq!(0.clamp(-2, 1), 0);
/// assert!(2.clamp(-2, 1) == 1); /// assert_eq!(2.clamp(-2, 1), 1);
/// ``` /// ```
#[must_use] #[must_use]
#[stable(feature = "clamp", since = "1.50.0")] #[stable(feature = "clamp", since = "1.50.0")]
@ -1060,11 +1057,9 @@ pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// let result = 1.0 < 2.0; /// assert_eq!(1.0 < 1.0, false);
/// assert_eq!(result, true); /// assert_eq!(1.0 < 2.0, true);
/// /// assert_eq!(2.0 < 1.0, false);
/// let result = 2.0 < 1.0;
/// assert_eq!(result, false);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1079,11 +1074,9 @@ pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// let result = 1.0 <= 2.0; /// assert_eq!(1.0 <= 1.0, true);
/// assert_eq!(result, true); /// assert_eq!(1.0 <= 2.0, true);
/// /// assert_eq!(2.0 <= 1.0, false);
/// let result = 2.0 <= 2.0;
/// assert_eq!(result, true);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1097,11 +1090,9 @@ pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// let result = 1.0 > 2.0; /// assert_eq!(1.0 > 1.0, false);
/// assert_eq!(result, false); /// assert_eq!(1.0 > 2.0, false);
/// /// assert_eq!(2.0 > 1.0, true);
/// let result = 2.0 > 2.0;
/// assert_eq!(result, false);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1116,11 +1107,9 @@ pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// let result = 2.0 >= 1.0; /// assert_eq!(1.0 >= 1.0, true);
/// assert_eq!(result, true); /// assert_eq!(1.0 >= 2.0, false);
/// /// assert_eq!(2.0 >= 1.0, true);
/// let result = 2.0 >= 2.0;
/// assert_eq!(result, true);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1150,8 +1139,8 @@ pub macro PartialOrd($item:item) {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(1, cmp::min(1, 2)); /// assert_eq!(cmp::min(1, 2), 1);
/// assert_eq!(2, cmp::min(2, 2)); /// assert_eq!(cmp::min(2, 2), 2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1170,8 +1159,11 @@ pub fn min<T: Ord>(v1: T, v2: T) -> T {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(cmp::min_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 1); /// let result = cmp::min_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs()));
/// assert_eq!(cmp::min_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2); /// assert_eq!(result, 1);
///
/// let result = cmp::min_by(-2, 3, |x: &i32, y: &i32| x.abs().cmp(&y.abs()));
/// assert_eq!(result, -2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1192,8 +1184,11 @@ pub fn min_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(cmp::min_by_key(-2, 1, |x: &i32| x.abs()), 1); /// let result = cmp::min_by_key(-2, 1, |x: &i32| x.abs());
/// assert_eq!(cmp::min_by_key(-2, 2, |x: &i32| x.abs()), -2); /// assert_eq!(result, 1);
///
/// let result = cmp::min_by_key(-2, 2, |x: &i32| x.abs());
/// assert_eq!(result, -2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1213,8 +1208,8 @@ pub fn min_by_key<T, F: FnMut(&T) -> K, K: Ord>(v1: T, v2: T, mut f: F) -> T {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(2, cmp::max(1, 2)); /// assert_eq!(cmp::max(1, 2), 2);
/// assert_eq!(2, cmp::max(2, 2)); /// assert_eq!(cmp::max(2, 2), 2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1233,8 +1228,11 @@ pub fn max<T: Ord>(v1: T, v2: T) -> T {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(cmp::max_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), -2); /// let result = cmp::max_by(-2, 1, |x: &i32, y: &i32| x.abs().cmp(&y.abs()));
/// assert_eq!(cmp::max_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())), 2); /// assert_eq!(result, -2);
///
/// let result = cmp::max_by(-2, 2, |x: &i32, y: &i32| x.abs().cmp(&y.abs())) ;
/// assert_eq!(result, 2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -1255,8 +1253,11 @@ pub fn max_by<T, F: FnOnce(&T, &T) -> Ordering>(v1: T, v2: T, compare: F) -> T {
/// ``` /// ```
/// use std::cmp; /// use std::cmp;
/// ///
/// assert_eq!(cmp::max_by_key(-2, 1, |x: &i32| x.abs()), -2); /// let result = cmp::max_by_key(-2, 1, |x: &i32| x.abs());
/// assert_eq!(cmp::max_by_key(-2, 2, |x: &i32| x.abs()), 2); /// assert_eq!(result, -2);
///
/// let result = cmp::max_by_key(-2, 2, |x: &i32| x.abs());
/// assert_eq!(result, 2);
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]