1
Fork 0

Replace float module consts with assoc consts in documentation

This commit is contained in:
Linus Färnstrand 2020-03-27 22:26:08 +01:00
parent c0ec0a27b3
commit c831265940
6 changed files with 13 additions and 15 deletions

View file

@ -817,7 +817,7 @@ pub trait PartialOrd<Rhs: ?Sized = Self>: PartialEq<Rhs> {
/// When comparison is impossible: /// When comparison is impossible:
/// ///
/// ``` /// ```
/// let result = std::f64::NAN.partial_cmp(&1.0); /// let result = f64::NAN.partial_cmp(&1.0);
/// assert_eq!(result, None); /// assert_eq!(result, None);
/// ``` /// ```
#[must_use] #[must_use]

View file

@ -2920,7 +2920,7 @@ pub trait Iterator {
/// assert_eq!([1.].iter().partial_cmp([1., 2.].iter()), Some(Ordering::Less)); /// assert_eq!([1.].iter().partial_cmp([1., 2.].iter()), Some(Ordering::Less));
/// assert_eq!([1., 2.].iter().partial_cmp([1.].iter()), Some(Ordering::Greater)); /// assert_eq!([1., 2.].iter().partial_cmp([1.].iter()), Some(Ordering::Greater));
/// ///
/// assert_eq!([std::f64::NAN].iter().partial_cmp([1.].iter()), None); /// assert_eq!([f64::NAN].iter().partial_cmp([1.].iter()), None);
/// ``` /// ```
#[stable(feature = "iter_order", since = "1.5.0")] #[stable(feature = "iter_order", since = "1.5.0")]
fn partial_cmp<I>(self, other: I) -> Option<Ordering> fn partial_cmp<I>(self, other: I) -> Option<Ordering>
@ -3170,7 +3170,7 @@ pub trait Iterator {
/// assert!(![1, 3, 2, 4].iter().is_sorted()); /// assert!(![1, 3, 2, 4].iter().is_sorted());
/// assert!([0].iter().is_sorted()); /// assert!([0].iter().is_sorted());
/// assert!(std::iter::empty::<i32>().is_sorted()); /// assert!(std::iter::empty::<i32>().is_sorted());
/// assert!(![0.0, 1.0, std::f32::NAN].iter().is_sorted()); /// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted());
/// ``` /// ```
#[inline] #[inline]
#[unstable(feature = "is_sorted", reason = "new API", issue = "53485")] #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
@ -3197,7 +3197,7 @@ pub trait Iterator {
/// assert!(![1, 3, 2, 4].iter().is_sorted_by(|a, b| a.partial_cmp(b))); /// assert!(![1, 3, 2, 4].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!([0].iter().is_sorted_by(|a, b| a.partial_cmp(b))); /// assert!([0].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!(std::iter::empty::<i32>().is_sorted_by(|a, b| a.partial_cmp(b))); /// assert!(std::iter::empty::<i32>().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!(![0.0, 1.0, std::f32::NAN].iter().is_sorted_by(|a, b| a.partial_cmp(b))); /// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// ``` /// ```
/// ///
/// [`is_sorted`]: trait.Iterator.html#method.is_sorted /// [`is_sorted`]: trait.Iterator.html#method.is_sorted

View file

@ -139,10 +139,9 @@ impl<Idx: PartialOrd<Idx>> Range<Idx> {
/// ``` /// ```
/// #![feature(range_is_empty)] /// #![feature(range_is_empty)]
/// ///
/// use std::f32::NAN;
/// assert!(!(3.0..5.0).is_empty()); /// assert!(!(3.0..5.0).is_empty());
/// assert!( (3.0..NAN).is_empty()); /// assert!( (3.0..f32::NAN).is_empty());
/// assert!( (NAN..5.0).is_empty()); /// assert!( (f32::NAN..5.0).is_empty());
/// ``` /// ```
#[unstable(feature = "range_is_empty", reason = "recently added", issue = "48111")] #[unstable(feature = "range_is_empty", reason = "recently added", issue = "48111")]
pub fn is_empty(&self) -> bool { pub fn is_empty(&self) -> bool {
@ -496,10 +495,9 @@ impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx> {
/// ``` /// ```
/// #![feature(range_is_empty)] /// #![feature(range_is_empty)]
/// ///
/// use std::f32::NAN;
/// assert!(!(3.0..=5.0).is_empty()); /// assert!(!(3.0..=5.0).is_empty());
/// assert!( (3.0..=NAN).is_empty()); /// assert!( (3.0..=f32::NAN).is_empty());
/// assert!( (NAN..=5.0).is_empty()); /// assert!( (f32::NAN..=5.0).is_empty());
/// ``` /// ```
/// ///
/// This method returns `true` after iteration has finished: /// This method returns `true` after iteration has finished:

View file

@ -2588,7 +2588,7 @@ impl<T> [T] {
/// assert!(![1, 3, 2, 4].is_sorted()); /// assert!(![1, 3, 2, 4].is_sorted());
/// assert!([0].is_sorted()); /// assert!([0].is_sorted());
/// assert!(empty.is_sorted()); /// assert!(empty.is_sorted());
/// assert!(![0.0, 1.0, std::f32::NAN].is_sorted()); /// assert!(![0.0, 1.0, f32::NAN].is_sorted());
/// ``` /// ```
#[inline] #[inline]
#[unstable(feature = "is_sorted", reason = "new API", issue = "53485")] #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]

View file

@ -284,7 +284,7 @@ impl f32 {
/// assert_eq!(a.rem_euclid(-b), 3.0); /// assert_eq!(a.rem_euclid(-b), 3.0);
/// assert_eq!((-a).rem_euclid(-b), 1.0); /// assert_eq!((-a).rem_euclid(-b), 1.0);
/// // limitation due to round-off error /// // limitation due to round-off error
/// assert!((-std::f32::EPSILON).rem_euclid(3.0) != 0.0); /// assert!((-f32::EPSILON).rem_euclid(3.0) != 0.0);
/// ``` /// ```
#[must_use = "method returns a new number and does not mutate the original value"] #[must_use = "method returns a new number and does not mutate the original value"]
#[inline] #[inline]
@ -962,7 +962,7 @@ impl f32 {
/// assert!((-3.0f32).clamp(-2.0, 1.0) == -2.0); /// assert!((-3.0f32).clamp(-2.0, 1.0) == -2.0);
/// assert!((0.0f32).clamp(-2.0, 1.0) == 0.0); /// assert!((0.0f32).clamp(-2.0, 1.0) == 0.0);
/// assert!((2.0f32).clamp(-2.0, 1.0) == 1.0); /// assert!((2.0f32).clamp(-2.0, 1.0) == 1.0);
/// assert!((std::f32::NAN).clamp(-2.0, 1.0).is_nan()); /// assert!((f32::NAN).clamp(-2.0, 1.0).is_nan());
/// ``` /// ```
#[must_use = "method returns a new number and does not mutate the original value"] #[must_use = "method returns a new number and does not mutate the original value"]
#[unstable(feature = "clamp", issue = "44095")] #[unstable(feature = "clamp", issue = "44095")]

View file

@ -280,7 +280,7 @@ impl f64 {
/// assert_eq!(a.rem_euclid(-b), 3.0); /// assert_eq!(a.rem_euclid(-b), 3.0);
/// assert_eq!((-a).rem_euclid(-b), 1.0); /// assert_eq!((-a).rem_euclid(-b), 1.0);
/// // limitation due to round-off error /// // limitation due to round-off error
/// assert!((-std::f64::EPSILON).rem_euclid(3.0) != 0.0); /// assert!((-f64::EPSILON).rem_euclid(3.0) != 0.0);
/// ``` /// ```
#[must_use = "method returns a new number and does not mutate the original value"] #[must_use = "method returns a new number and does not mutate the original value"]
#[inline] #[inline]
@ -928,7 +928,7 @@ impl f64 {
/// assert!((-3.0f64).clamp(-2.0, 1.0) == -2.0); /// assert!((-3.0f64).clamp(-2.0, 1.0) == -2.0);
/// assert!((0.0f64).clamp(-2.0, 1.0) == 0.0); /// assert!((0.0f64).clamp(-2.0, 1.0) == 0.0);
/// assert!((2.0f64).clamp(-2.0, 1.0) == 1.0); /// assert!((2.0f64).clamp(-2.0, 1.0) == 1.0);
/// assert!((std::f64::NAN).clamp(-2.0, 1.0).is_nan()); /// assert!((f64::NAN).clamp(-2.0, 1.0).is_nan());
/// ``` /// ```
#[must_use = "method returns a new number and does not mutate the original value"] #[must_use = "method returns a new number and does not mutate the original value"]
#[unstable(feature = "clamp", issue = "44095")] #[unstable(feature = "clamp", issue = "44095")]