rustdoc: extend #[doc(tuple_variadic)]
to fn pointers
The attribute is also renamed `fake_variadic`.
This commit is contained in:
parent
263edd43c5
commit
1169832f2f
21 changed files with 61 additions and 42 deletions
|
@ -402,8 +402,8 @@ impl<'a> Visitor<'a> for PostExpansionVisitor<'a> {
|
||||||
gate_feature_post!(self, rustdoc_internals, attr.span, msg);
|
gate_feature_post!(self, rustdoc_internals, attr.span, msg);
|
||||||
}
|
}
|
||||||
|
|
||||||
if nested_meta.has_name(sym::tuple_variadic) {
|
if nested_meta.has_name(sym::fake_variadic) {
|
||||||
let msg = "`#[doc(tuple_variadic)]` is meant for internal use only";
|
let msg = "`#[doc(fake_variadic)]` is meant for internal use only";
|
||||||
gate_feature_post!(self, rustdoc_internals, attr.span, msg);
|
gate_feature_post!(self, rustdoc_internals, attr.span, msg);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -81,8 +81,8 @@ passes-doc-keyword-not-mod = `#[doc(keyword = "...")]` should be used on modules
|
||||||
|
|
||||||
passes-doc-keyword-invalid-ident = `{$doc_keyword}` is not a valid identifier
|
passes-doc-keyword-invalid-ident = `{$doc_keyword}` is not a valid identifier
|
||||||
|
|
||||||
passes-doc-tuple-variadic-not-first =
|
passes-doc-fake-variadic-not-valid =
|
||||||
`#[doc(tuple_variadic)]` must be used on the first of a set of tuple trait impls with varying arity
|
`#[doc(fake_variadic)]` must be used on the first of a set of tuple or fn pointer trait impls with varying arity
|
||||||
|
|
||||||
passes-doc-keyword-only-impl = `#[doc(keyword = "...")]` should be used on impl blocks
|
passes-doc-keyword-only-impl = `#[doc(keyword = "...")]` should be used on impl blocks
|
||||||
|
|
||||||
|
|
|
@ -706,14 +706,20 @@ impl CheckAttrVisitor<'_> {
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
fn check_doc_tuple_variadic(&self, meta: &NestedMetaItem, hir_id: HirId) -> bool {
|
fn check_doc_fake_variadic(&self, meta: &NestedMetaItem, hir_id: HirId) -> bool {
|
||||||
match self.tcx.hir().find(hir_id).and_then(|node| match node {
|
match self.tcx.hir().find(hir_id).and_then(|node| match node {
|
||||||
hir::Node::Item(item) => Some(&item.kind),
|
hir::Node::Item(item) => Some(&item.kind),
|
||||||
_ => None,
|
_ => None,
|
||||||
}) {
|
}) {
|
||||||
Some(ItemKind::Impl(ref i)) => {
|
Some(ItemKind::Impl(ref i)) => {
|
||||||
if !matches!(&i.self_ty.kind, hir::TyKind::Tup([_])) {
|
let is_valid = matches!(&i.self_ty.kind, hir::TyKind::Tup([_]))
|
||||||
self.tcx.sess.emit_err(errors::DocTupleVariadicNotFirst { span: meta.span() });
|
|| if let hir::TyKind::BareFn(bare_fn_ty) = &i.self_ty.kind {
|
||||||
|
bare_fn_ty.decl.inputs.len() == 1
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
};
|
||||||
|
if !is_valid {
|
||||||
|
self.tcx.sess.emit_err(errors::DocFakeVariadicNotValid { span: meta.span() });
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -887,9 +893,9 @@ impl CheckAttrVisitor<'_> {
|
||||||
is_valid = false
|
is_valid = false
|
||||||
}
|
}
|
||||||
|
|
||||||
sym::tuple_variadic
|
sym::fake_variadic
|
||||||
if !self.check_attr_not_crate_level(meta, hir_id, "tuple_variadic")
|
if !self.check_attr_not_crate_level(meta, hir_id, "fake_variadic")
|
||||||
|| !self.check_doc_tuple_variadic(meta, hir_id) =>
|
|| !self.check_doc_fake_variadic(meta, hir_id) =>
|
||||||
{
|
{
|
||||||
is_valid = false
|
is_valid = false
|
||||||
}
|
}
|
||||||
|
@ -939,7 +945,7 @@ impl CheckAttrVisitor<'_> {
|
||||||
| sym::notable_trait
|
| sym::notable_trait
|
||||||
| sym::passes
|
| sym::passes
|
||||||
| sym::plugins
|
| sym::plugins
|
||||||
| sym::tuple_variadic => {}
|
| sym::fake_variadic => {}
|
||||||
|
|
||||||
sym::test => {
|
sym::test => {
|
||||||
if !self.check_test_attr(meta, hir_id) {
|
if !self.check_test_attr(meta, hir_id) {
|
||||||
|
|
|
@ -212,8 +212,8 @@ pub struct DocKeywordInvalidIdent {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(SessionDiagnostic)]
|
#[derive(SessionDiagnostic)]
|
||||||
#[error(passes::doc_tuple_variadic_not_first)]
|
#[error(passes::doc_fake_variadic_not_valid)]
|
||||||
pub struct DocTupleVariadicNotFirst {
|
pub struct DocFakeVariadicNotValid {
|
||||||
#[primary_span]
|
#[primary_span]
|
||||||
pub span: Span,
|
pub span: Span,
|
||||||
}
|
}
|
||||||
|
|
|
@ -685,6 +685,7 @@ symbols! {
|
||||||
fabsf32,
|
fabsf32,
|
||||||
fabsf64,
|
fabsf64,
|
||||||
fadd_fast,
|
fadd_fast,
|
||||||
|
fake_variadic,
|
||||||
fdiv_fast,
|
fdiv_fast,
|
||||||
feature,
|
feature,
|
||||||
fence,
|
fence,
|
||||||
|
@ -1460,7 +1461,6 @@ symbols! {
|
||||||
tuple,
|
tuple,
|
||||||
tuple_from_req,
|
tuple_from_req,
|
||||||
tuple_indexing,
|
tuple_indexing,
|
||||||
tuple_variadic,
|
|
||||||
two_phase,
|
two_phase,
|
||||||
ty,
|
ty,
|
||||||
type_alias_enum_variants,
|
type_alias_enum_variants,
|
||||||
|
|
|
@ -2562,7 +2562,7 @@ macro_rules! tuple {
|
||||||
|
|
||||||
macro_rules! maybe_tuple_doc {
|
macro_rules! maybe_tuple_doc {
|
||||||
($a:ident @ #[$meta:meta] $item:item) => {
|
($a:ident @ #[$meta:meta] $item:item) => {
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
||||||
#[$meta]
|
#[$meta]
|
||||||
$item
|
$item
|
||||||
|
|
|
@ -900,7 +900,7 @@ mod impls {
|
||||||
|
|
||||||
macro_rules! maybe_tuple_doc {
|
macro_rules! maybe_tuple_doc {
|
||||||
($a:ident @ #[$meta:meta] $item:item) => {
|
($a:ident @ #[$meta:meta] $item:item) => {
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
||||||
#[$meta]
|
#[$meta]
|
||||||
$item
|
$item
|
||||||
|
|
|
@ -996,7 +996,7 @@ impl<T> (T,) {}
|
||||||
// Fake impl that's only really used for docs.
|
// Fake impl that's only really used for docs.
|
||||||
#[cfg(doc)]
|
#[cfg(doc)]
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
/// This trait is implemented on arbitrary-length tuples.
|
/// This trait is implemented on arbitrary-length tuples.
|
||||||
impl<T: Clone> Clone for (T,) {
|
impl<T: Clone> Clone for (T,) {
|
||||||
fn clone(&self) -> Self {
|
fn clone(&self) -> Self {
|
||||||
|
@ -1007,7 +1007,7 @@ impl<T: Clone> Clone for (T,) {
|
||||||
// Fake impl that's only really used for docs.
|
// Fake impl that's only really used for docs.
|
||||||
#[cfg(doc)]
|
#[cfg(doc)]
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
/// This trait is implemented on arbitrary-length tuples.
|
/// This trait is implemented on arbitrary-length tuples.
|
||||||
impl<T: Copy> Copy for (T,) {
|
impl<T: Copy> Copy for (T,) {
|
||||||
// empty
|
// empty
|
||||||
|
|
|
@ -107,7 +107,7 @@ macro_rules! tuple_impls {
|
||||||
// Otherwise, it hides the docs entirely.
|
// Otherwise, it hides the docs entirely.
|
||||||
macro_rules! maybe_tuple_doc {
|
macro_rules! maybe_tuple_doc {
|
||||||
($a:ident @ #[$meta:meta] $item:item) => {
|
($a:ident @ #[$meta:meta] $item:item) => {
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
#[doc = "This trait is implemented for tuples up to twelve items long."]
|
||||||
#[$meta]
|
#[$meta]
|
||||||
$item
|
$item
|
||||||
|
|
|
@ -996,7 +996,7 @@ impl<T> (T,) {}
|
||||||
// Fake impl that's only really used for docs.
|
// Fake impl that's only really used for docs.
|
||||||
#[cfg(doc)]
|
#[cfg(doc)]
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
/// This trait is implemented on arbitrary-length tuples.
|
/// This trait is implemented on arbitrary-length tuples.
|
||||||
impl<T: Clone> Clone for (T,) {
|
impl<T: Clone> Clone for (T,) {
|
||||||
fn clone(&self) -> Self {
|
fn clone(&self) -> Self {
|
||||||
|
@ -1007,7 +1007,7 @@ impl<T: Clone> Clone for (T,) {
|
||||||
// Fake impl that's only really used for docs.
|
// Fake impl that's only really used for docs.
|
||||||
#[cfg(doc)]
|
#[cfg(doc)]
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
#[doc(tuple_variadic)]
|
#[cfg_attr(not(bootstrap), doc(fake_variadic))]
|
||||||
/// This trait is implemented on arbitrary-length tuples.
|
/// This trait is implemented on arbitrary-length tuples.
|
||||||
impl<T: Copy> Copy for (T,) {
|
impl<T: Copy> Copy for (T,) {
|
||||||
// empty
|
// empty
|
||||||
|
|
|
@ -506,8 +506,8 @@ pub(crate) fn build_impl(
|
||||||
for_,
|
for_,
|
||||||
items: trait_items,
|
items: trait_items,
|
||||||
polarity,
|
polarity,
|
||||||
kind: if utils::has_doc_flag(tcx, did, sym::tuple_variadic) {
|
kind: if utils::has_doc_flag(tcx, did, sym::fake_variadic) {
|
||||||
ImplKind::TupleVaradic
|
ImplKind::FakeVaradic
|
||||||
} else {
|
} else {
|
||||||
ImplKind::Normal
|
ImplKind::Normal
|
||||||
},
|
},
|
||||||
|
|
|
@ -2005,8 +2005,8 @@ fn clean_impl<'tcx>(
|
||||||
for_,
|
for_,
|
||||||
items,
|
items,
|
||||||
polarity: tcx.impl_polarity(def_id),
|
polarity: tcx.impl_polarity(def_id),
|
||||||
kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::tuple_variadic) {
|
kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::fake_variadic) {
|
||||||
ImplKind::TupleVaradic
|
ImplKind::FakeVaradic
|
||||||
} else {
|
} else {
|
||||||
ImplKind::Normal
|
ImplKind::Normal
|
||||||
},
|
},
|
||||||
|
|
|
@ -2394,7 +2394,7 @@ impl Impl {
|
||||||
pub(crate) enum ImplKind {
|
pub(crate) enum ImplKind {
|
||||||
Normal,
|
Normal,
|
||||||
Auto,
|
Auto,
|
||||||
TupleVaradic,
|
FakeVaradic,
|
||||||
Blanket(Box<Type>),
|
Blanket(Box<Type>),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2407,8 +2407,8 @@ impl ImplKind {
|
||||||
matches!(self, ImplKind::Blanket(_))
|
matches!(self, ImplKind::Blanket(_))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn is_tuple_variadic(&self) -> bool {
|
pub(crate) fn is_fake_variadic(&self) -> bool {
|
||||||
matches!(self, ImplKind::TupleVaradic)
|
matches!(self, ImplKind::FakeVaradic)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn as_blanket_ty(&self) -> Option<&Type> {
|
pub(crate) fn as_blanket_ty(&self) -> Option<&Type> {
|
||||||
|
|
|
@ -1165,10 +1165,23 @@ impl clean::Impl {
|
||||||
|
|
||||||
if let clean::Type::Tuple(types) = &self.for_ &&
|
if let clean::Type::Tuple(types) = &self.for_ &&
|
||||||
let [clean::Type::Generic(name)] = &types[..] &&
|
let [clean::Type::Generic(name)] = &types[..] &&
|
||||||
(self.kind.is_tuple_variadic() || self.kind.is_auto()) {
|
(self.kind.is_fake_variadic() || self.kind.is_auto()) {
|
||||||
// Hardcoded anchor library/core/src/primitive_docs.rs
|
// Hardcoded anchor library/core/src/primitive_docs.rs
|
||||||
// Link should match `# Trait implementations`
|
// Link should match `# Trait implementations`
|
||||||
primitive_link_fragment(f, PrimitiveType::Tuple, &format!("({name}₁, {name}₂, …, {name}ₙ)"), "#trait-implementations-1", cx)?;
|
primitive_link_fragment(f, PrimitiveType::Tuple, &format!("({name}₁, {name}₂, …, {name}ₙ)"), "#trait-implementations-1", cx)?;
|
||||||
|
} else if let clean::Type::BareFunction(bare_fn) = &self.for_ &&
|
||||||
|
let [clean::Argument { type_: clean::Type::Generic(name), .. }] = &bare_fn.decl.inputs.values[..] &&
|
||||||
|
(self.kind.is_fake_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!("fn ({name}₁, {name}₂, …, {name}ₙ)"), "#trait-implementations-1", cx)?;
|
||||||
|
// Not implemented.
|
||||||
|
assert!(!bare_fn.decl.c_variadic);
|
||||||
|
// Write output.
|
||||||
|
if let clean::FnRetTy::Return(ty) = &bare_fn.decl.output {
|
||||||
|
write!(f, " -> ")?;
|
||||||
|
fmt_type(ty, f, use_absolute, cx)?;
|
||||||
|
}
|
||||||
} else if let Some(ty) = self.kind.as_blanket_ty() {
|
} else if let Some(ty) = self.kind.as_blanket_ty() {
|
||||||
fmt_type(ty, f, use_absolute, cx)?;
|
fmt_type(ty, f, use_absolute, cx)?;
|
||||||
} else {
|
} else {
|
||||||
|
|
|
@ -574,7 +574,7 @@ impl FromWithTcx<clean::Impl> for Impl {
|
||||||
let trait_ = trait_.map(|path| clean::Type::Path { path }.into_tcx(tcx));
|
let trait_ = trait_.map(|path| clean::Type::Path { path }.into_tcx(tcx));
|
||||||
// FIXME: use something like ImplKind in JSON?
|
// FIXME: use something like ImplKind in JSON?
|
||||||
let (synthetic, blanket_impl) = match kind {
|
let (synthetic, blanket_impl) = match kind {
|
||||||
clean::ImplKind::Normal | clean::ImplKind::TupleVaradic => (false, None),
|
clean::ImplKind::Normal | clean::ImplKind::FakeVaradic => (false, None),
|
||||||
clean::ImplKind::Auto => (true, None),
|
clean::ImplKind::Auto => (true, None),
|
||||||
clean::ImplKind::Blanket(ty) => (false, Some(*ty)),
|
clean::ImplKind::Blanket(ty) => (false, Some(*ty)),
|
||||||
};
|
};
|
||||||
|
|
|
@ -3,13 +3,13 @@
|
||||||
trait Mine {}
|
trait Mine {}
|
||||||
|
|
||||||
// This one is fine
|
// This one is fine
|
||||||
#[doc(tuple_variadic)]
|
#[doc(fake_variadic)]
|
||||||
impl<T> Mine for (T,) {}
|
impl<T> Mine for (T,) {}
|
||||||
|
|
||||||
trait Mine2 {}
|
trait Mine2 {}
|
||||||
|
|
||||||
// This one is not
|
// This one is not
|
||||||
#[doc(tuple_variadic)] //~ ERROR
|
#[doc(fake_variadic)] //~ ERROR
|
||||||
impl<T, U> Mine for (T,U) {}
|
impl<T, U> Mine for (T,U) {}
|
||||||
|
|
||||||
fn main() {}
|
fn main() {}
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
error: `#[doc(tuple_variadic)]` must be used on the first of a set of tuple trait impls with varying arity
|
error: `#[doc(fake_variadic)]` must be used on the first of a set of tuple or fn pointer trait impls with varying arity
|
||||||
--> $DIR/tuple-variadic-check.rs:12:7
|
--> $DIR/tuple-variadic-check.rs:12:7
|
||||||
|
|
|
|
||||||
LL | #[doc(tuple_variadic)]
|
LL | #[doc(fake_variadic)]
|
||||||
| ^^^^^^^^^^^^^^
|
| ^^^^^^^^^^^^^
|
||||||
|
|
||||||
error: aborting due to previous error
|
error: aborting due to previous error
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
// @has - '//h2[@id="trait-implementations-1"]' 'Trait implementations'
|
// @has - '//h2[@id="trait-implementations-1"]' 'Trait implementations'
|
||||||
/// # Trait implementations
|
/// # Trait implementations
|
||||||
///
|
///
|
||||||
/// This header is hard-coded in the HTML format linking for `#[doc(tuple_variadics)]`.
|
/// This header is hard-coded in the HTML format linking for `#[doc(fake_variadics)]`.
|
||||||
/// To make sure it gets linked correctly, we need to make sure the hardcoded anchor
|
/// To make sure it gets linked correctly, we need to make sure the hardcoded anchor
|
||||||
/// in the code matches what rustdoc generates for the header.
|
/// in the code matches what rustdoc generates for the header.
|
||||||
mod tuple_prim {}
|
mod tuple_prim {}
|
||||||
|
|
|
@ -7,12 +7,12 @@ pub trait Foo {}
|
||||||
|
|
||||||
// @has foo/trait.Foo.html
|
// @has foo/trait.Foo.html
|
||||||
// @has - '//section[@id="impl-Foo-for-(T%2C)"]/h3' 'impl<T> Foo for (T₁, T₂, …, Tₙ)'
|
// @has - '//section[@id="impl-Foo-for-(T%2C)"]/h3' 'impl<T> Foo for (T₁, T₂, …, Tₙ)'
|
||||||
#[doc(tuple_variadic)]
|
#[doc(fake_variadic)]
|
||||||
impl<T> Foo for (T,) {}
|
impl<T> Foo for (T,) {}
|
||||||
|
|
||||||
pub trait Bar {}
|
pub trait Bar {}
|
||||||
|
|
||||||
// @has foo/trait.Bar.html
|
// @has foo/trait.Bar.html
|
||||||
// @has - '//section[@id="impl-Bar-for-(U%2C)"]/h3' 'impl<U: Foo> Bar for (U₁, U₂, …, Uₙ)'
|
// @has - '//section[@id="impl-Bar-for-(U%2C)"]/h3' 'impl<U: Foo> Bar for (U₁, U₂, …, Uₙ)'
|
||||||
#[doc(tuple_variadic)]
|
#[doc(fake_variadic)]
|
||||||
impl<U: Foo> Bar for (U,) {}
|
impl<U: Foo> Bar for (U,) {}
|
||||||
|
|
|
@ -4,7 +4,7 @@ mod foo {}
|
||||||
|
|
||||||
trait Mine {}
|
trait Mine {}
|
||||||
|
|
||||||
#[doc(tuple_variadic)] //~ ERROR: `#[doc(tuple_variadic)]` is meant for internal use only
|
#[doc(fake_variadic)] //~ ERROR: `#[doc(fake_variadic)]` is meant for internal use only
|
||||||
impl<T> Mine for (T,) {}
|
impl<T> Mine for (T,) {}
|
||||||
|
|
||||||
fn main() {}
|
fn main() {}
|
||||||
|
|
|
@ -7,11 +7,11 @@ LL | #[doc(keyword = "match")]
|
||||||
= note: see issue #90418 <https://github.com/rust-lang/rust/issues/90418> for more information
|
= note: see issue #90418 <https://github.com/rust-lang/rust/issues/90418> for more information
|
||||||
= help: add `#![feature(rustdoc_internals)]` to the crate attributes to enable
|
= help: add `#![feature(rustdoc_internals)]` to the crate attributes to enable
|
||||||
|
|
||||||
error[E0658]: `#[doc(tuple_variadic)]` is meant for internal use only
|
error[E0658]: `#[doc(fake_variadic)]` is meant for internal use only
|
||||||
--> $DIR/feature-gate-rustdoc_internals.rs:7:1
|
--> $DIR/feature-gate-rustdoc_internals.rs:7:1
|
||||||
|
|
|
|
||||||
LL | #[doc(tuple_variadic)]
|
LL | #[doc(fake_variadic)]
|
||||||
| ^^^^^^^^^^^^^^^^^^^^^^
|
| ^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
|
|
||||||
= note: see issue #90418 <https://github.com/rust-lang/rust/issues/90418> for more information
|
= note: see issue #90418 <https://github.com/rust-lang/rust/issues/90418> for more information
|
||||||
= help: add `#![feature(rustdoc_internals)]` to the crate attributes to enable
|
= help: add `#![feature(rustdoc_internals)]` to the crate attributes to enable
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue