Improve core::cmp docs #21990

steveklabnik · 2015-02-06T02:58:45Z

Fix up, add examples, make them all the same.

rust-highfive · 2015-02-06T02:58:50Z

(rust_highfive has picked a reviewer for you, use r? to override)

nagisa · 2015-02-06T07:28:42Z

src/libcore/cmp.rs

 ///
 /// - reflexive: `a == a`;
 /// - symmetric: `a == b` implies `b == a`; and
 /// - transitive: `a == b` and `b == c` implies `a == c`.
+///
+/// This property cannot be checked by the compiler, and so `Eq` implies `PartialEq`, and has no


I think s/and so/therefore/ would sound better here.

steveklabnik · 2015-02-08T22:54:02Z

Feedback addressed.

huonw · 2015-02-11T03:14:05Z

src/libcore/cmp.rs

@@ -8,35 +8,33 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.

-//! Defines the `PartialOrd` and `PartialEq` comparison traits.
+//! Traits for ordering and comparison.


Maybe s/Traits/Functionality/ since there's things other than traits? (I could just be overly nit-picky)

huonw · 2015-02-11T03:32:49Z

src/libcore/cmp.rs

+    /// assert_eq!(Ordering::Greater.reverse(), Ordering::Less);
+    /// ```
+    ///
+    /// This method is often used to reverse a comparison:


s/is often/can be/

huonw · 2015-02-11T03:34:49Z

src/libcore/cmp.rs

+/// use std::cmp;
+///
+/// assert_eq!(Some(1), cmp::partial_min(1, 2));
+/// assert_eq!(Some(2), cmp::partial_min(2, 2));


Similarly these could demonstrate returning None, also using NaN.

(Totally minor: Is there a reason that these ones have cmp::partial_min(2, 2) but the non-partial ones don't?)

I thought I was making them all the same, but it's possible that i just screwed tha tup

huonw · 2015-02-11T04:11:40Z

src/libcore/cmp.rs

@@ -302,6 +422,15 @@ pub fn partial_min<T: PartialOrd>(v1: T, v2: T) -> Option<T> {
 /// Compare and return the maximum of two values if there is one.
 ///
 /// Returns the first argument if the comparison determines them to be equal.
+///
+/// # Examples


This could have a NaN example too.

truth. fixed!

huonw · 2015-02-11T07:14:38Z

src/libcore/cmp.rs

+/// When comparison is impossible:
+///
+/// ```
+/// let result = std::f64::NAN.partial_min(&1.0);


This and partial_max should be function calls, not methods.

steveklabnik · 2015-02-13T13:52:01Z

@huonw should be good to go now

huonw · 2015-02-16T10:26:52Z

@bors r+ 17f9 rollup

Fix up, add examples, make them all the same.

rust-highfive assigned aturon Feb 6, 2015

nagisa reviewed Feb 6, 2015
View reviewed changes

steveklabnik force-pushed the doc_core_cmp branch from 7be82c7 to 2307a5c Compare February 8, 2015 22:53