about summary refs log tree commit diff
path: root/src/libstd/primitive_docs.rs
diff options
context:
space:
mode:
authorChris Gregory <czipperz@gmail.com>2019-05-26 21:04:05 -0500
committerChris Gregory <czipperz@gmail.com>2019-05-26 21:04:05 -0500
commit0fd9934b1e2c523cf32ee2f88450dab9feb65ee4 (patch)
tree9ebf8b1c5347132b1652f1d5c01e7c5035f228be /src/libstd/primitive_docs.rs
parentdc6db14e1cd60012f25be4fd8d2eb96ea5b4bb68 (diff)
downloadrust-0fd9934b1e2c523cf32ee2f88450dab9feb65ee4.tar.gz
rust-0fd9934b1e2c523cf32ee2f88450dab9feb65ee4.zip
Document tuple's Ord behavior as sequential
Diffstat (limited to 'src/libstd/primitive_docs.rs')
-rw-r--r--src/libstd/primitive_docs.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs
index 24f728158c4..42b64d2b5a5 100644
--- a/src/libstd/primitive_docs.rs
+++ b/src/libstd/primitive_docs.rs
@@ -683,6 +683,10 @@ mod prim_str { }
 /// assert_eq!(tuple.2, 'c');
 /// ```
 ///
+/// The sequential nature of the tuple applies to its implementations of various
+/// traits.  For example, in `PartialOrd` and `Ord`, the elements are compared
+/// sequentially until the first non-equal set is found.
+///
 /// For more about tuples, see [the book](../book/ch03-02-data-types.html#the-tuple-type).
 ///
 /// # Trait implementations