summaryrefslogtreecommitdiff
path: root/src/libcore/cmp.rs
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-06-30 18:46:31 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-06-30 19:37:34 -0400
commit8b81f76593ce044b0d822f07061c93b515f7dc01 (patch)
treed52b711a16be5770d3d1b2b7d9aed21d0a4d2d82 /src/libcore/cmp.rs
parentfdf219dd42ad6a1627dd949d3f92193d0c482226 (diff)
downloadrust-8b81f76593ce044b0d822f07061c93b515f7dc01.tar.gz
Make note of Ord's derive ordering
Fixes #26620
Diffstat (limited to 'src/libcore/cmp.rs')
-rw-r--r--src/libcore/cmp.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libcore/cmp.rs b/src/libcore/cmp.rs
index 0269499ad54..52ed29c1b61 100644
--- a/src/libcore/cmp.rs
+++ b/src/libcore/cmp.rs
@@ -166,6 +166,8 @@ impl Ordering {
///
/// - total and antisymmetric: exactly one of `a < b`, `a == b` or `a > b` is true; and
/// - transitive, `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
+///
+/// When this trait is `derive`d, it produces a lexicographic ordering.
#[stable(feature = "rust1", since = "1.0.0")]
pub trait Ord: Eq + PartialOrd<Self> {
/// This method returns an `Ordering` between `self` and `other`.