From 330dab837fb872051b365715f1532eb8156c33ae Mon Sep 17 00:00:00 2001
From: Behnam Esfahbod <behnam@zwnj.org>
Date: Mon, 26 Jun 2017 18:27:01 -0600
Subject: [PATCH] [libcore/cmp] Expand Ord/PartialOrd Derivable doc for enum
types
Expand Derivable docblock section for `Ord` and `PartialOrd` to cover
`enum` types, in addition to the existing language explaining it for
`struct` types.
---
src/libcore/cmp.rs | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/libcore/cmp.rs b/src/libcore/cmp.rs
index 6f35d0417f18b..2e691ea4af26e 100644
--- a/src/libcore/cmp.rs
+++ b/src/libcore/cmp.rs
@@ -380,8 +380,9 @@ impl<T: Ord> Ord for Reverse<T> {
///
/// ## Derivable
///
-/// This trait can be used with `#[derive]`. When `derive`d, it will produce a lexicographic
-/// ordering based on the top-to-bottom declaration order of the struct's members.
+/// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
+/// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
+/// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
///
/// ## How can I implement `Ord`?
///
@@ -513,8 +514,9 @@ impl PartialOrd for Ordering {
///
/// ## Derivable
///
-/// This trait can be used with `#[derive]`. When `derive`d, it will produce a lexicographic
-/// ordering based on the top-to-bottom declaration order of the struct's members.
+/// This trait can be used with `#[derive]`. When `derive`d on structs, it will produce a
+/// lexicographic ordering based on the top-to-bottom declaration order of the struct's members.
+/// When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.
///
/// ## How can I implement `PartialOrd`?
///