about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2016-02-09 13:33:02 -0500
committerSteve Klabnik <steve@steveklabnik.com>2016-02-09 16:00:54 -0500
commit8fa48573e15b50971c8f20bea1250407ea3f586c (patch)
tree67ed5290b3f20adf0c2133ca455f7132460a668f /src/libstd
parent4ebc47bad2d50138e981d403000cf311c760169c (diff)
downloadrust-8fa48573e15b50971c8f20bea1250407ea3f586c.tar.gz
rust-8fa48573e15b50971c8f20bea1250407ea3f586c.zip
make note of arity and 32-length restriction
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/primitive_docs.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs
index 2be8c41a496..ad93fe0094a 100644
--- a/src/libstd/primitive_docs.rs
+++ b/src/libstd/primitive_docs.rs
@@ -366,6 +366,9 @@ mod prim_str { }
 /// ("hello", 5, 'c');
 /// ```
 ///
+/// 'Length' is also sometimes called 'arity' here; each tuple of a different
+/// length is a different, distinct type.
+///
 /// Tuples are *heterogeneous*. This means that each element of the tuple can
 /// have a different type. In that tuple above, it has the type:
 ///
@@ -409,6 +412,9 @@ mod prim_str { }
 /// [`Default`]: ../default/trait.Default.html
 /// [`Hash`]: ../hash/trait.Hash.html
 ///
+/// Due to a temporary restriction in Rust's type system, these traits are only
+/// implemented on tuples of arity 32 or less. In the future, this may change.
+///
 /// # Examples
 ///
 /// Basic usage: