nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-02-06 12:04:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

rustdoc: change "variadic tuple" notation to look less like real syntax

Browse Source
This commit is contained in:
Michael Howell 2022-06-14 12:21:38 -07:00
parent 94396711dd
commit 2bbf44f655
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
library/core/src/primitive_docs.rs
View File

@ -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:

8
library/std/src/primitive_docs.rs
View File

@ -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:

2
src/librustdoc/html/format.rs
View File

@ -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 {