diff options
| author | Michael Howell <michael@notriddle.com> | 2022-06-14 12:21:38 -0700 |
|---|---|---|
| committer | Michael Howell <michael@notriddle.com> | 2022-06-14 12:21:38 -0700 |
| commit | 2bbf44f655bc6b1073009cab56884b09666de6c3 (patch) | |
| tree | ac413ddf6bb610e6581a30901bce91f233c58520 | |
| parent | 94396711dd4a4c535664c0b85696bbe089198b8e (diff) | |
| download | rust-2bbf44f655bc6b1073009cab56884b09666de6c3.tar.gz rust-2bbf44f655bc6b1073009cab56884b09666de6c3.zip | |
rustdoc: change "variadic tuple" notation to look less like real syntax
| -rw-r--r-- | library/core/src/primitive_docs.rs | 8 | ||||
| -rw-r--r-- | library/std/src/primitive_docs.rs | 8 | ||||
| -rw-r--r-- | src/librustdoc/html/format.rs | 2 |
3 files changed, 9 insertions, 9 deletions
diff --git a/library/core/src/primitive_docs.rs b/library/core/src/primitive_docs.rs index a19840ac576..00793f7f920 100644 --- a/library/core/src/primitive_docs.rs +++ b/library/core/src/primitive_docs.rs @@ -918,10 +918,10 @@ mod prim_str {} // linked to as `#trait-implementations-1` /// # Trait implementations /// -/// In this documentation the shorthand `(T, ...)` is used to represent tuples of varying length. -/// When that is used, any trait bound expressed on `T` applies to each element of the tuple -/// independently. Note that this is a convenience notation to avoid repetitive documentation, -/// not valid Rust syntax. +/// In this documentation the shorthand `(T₁, T₂, …, Tₙ)` is used to represent tuples of varying +/// length. When that is used, any trait bound expressed on `T` applies to each element of the +/// tuple independently. Note that this is a convenience notation to avoid repetitive +/// documentation, not valid Rust syntax. /// /// Due to a temporary restriction in Rust’s type system, the following traits are only /// implemented on tuples of arity 12 or less. In the future, this may change: diff --git a/library/std/src/primitive_docs.rs b/library/std/src/primitive_docs.rs index a19840ac576..00793f7f920 100644 --- a/library/std/src/primitive_docs.rs +++ b/library/std/src/primitive_docs.rs @@ -918,10 +918,10 @@ mod prim_str {} // linked to as `#trait-implementations-1` /// # Trait implementations /// -/// In this documentation the shorthand `(T, ...)` is used to represent tuples of varying length. -/// When that is used, any trait bound expressed on `T` applies to each element of the tuple -/// independently. Note that this is a convenience notation to avoid repetitive documentation, -/// not valid Rust syntax. +/// In this documentation the shorthand `(T₁, T₂, …, Tₙ)` is used to represent tuples of varying +/// length. When that is used, any trait bound expressed on `T` applies to each element of the +/// tuple independently. Note that this is a convenience notation to avoid repetitive +/// documentation, not valid Rust syntax. /// /// Due to a temporary restriction in Rust’s type system, the following traits are only /// implemented on tuples of arity 12 or less. In the future, this may change: diff --git a/src/librustdoc/html/format.rs b/src/librustdoc/html/format.rs index c714549d0f5..5520430b043 100644 --- a/src/librustdoc/html/format.rs +++ b/src/librustdoc/html/format.rs @@ -1079,7 +1079,7 @@ impl clean::Impl { (self.kind.is_tuple_variadic() || self.kind.is_auto()) { // Hardcoded anchor library/core/src/primitive_docs.rs // Link should match `# Trait implementations` - primitive_link_fragment(f, PrimitiveType::Tuple, &format!("({name}, ...)"), "#trait-implementations-1", cx)?; + primitive_link_fragment(f, PrimitiveType::Tuple, &format!("({name}₁, {name}₂, …, {name}ₙ)"), "#trait-implementations-1", cx)?; } else if let Some(ty) = self.kind.as_blanket_ty() { fmt_type(ty, f, use_absolute, cx)?; } else { |