mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-23 07:14:28 +00:00
6c8001b85c
Warn on unused `#[doc(hidden)]` attributes on trait impl items [Zulip conversation](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/.E2.9C.94.20Validy.20checks.20for.20.60.23.5Bdoc.28hidden.29.5D.60). Whether an associated item in a trait impl is shown or hidden in the documentation entirely depends on the corresponding item in the trait declaration. Rustdoc completely ignores `#[doc(hidden)]` attributes on impl items. No error or warning is emitted: ```rust pub trait Tr { fn f(); } pub struct Ty; impl Tr for Ty { #[doc(hidden)] fn f() {} } // ^^^^^^^^^^^^^^ ignored by rustdoc and currently // no error or warning issued ``` This may lead users to the wrong belief that the attribute has an effect. In fact, several such cases are found in the standard library (I've removed all of them in this PR). There does not seem to exist any incentive to allow this in the future either: Impl'ing a trait for a type means the type *fully* conforms to its API. Users can add `#[doc(hidden)]` to the whole impl if they want to hide the implementation or add the attribute to the corresponding associated item in the trait declaration to hide the specific item. Hiding an implementation of an associated item does not make much sense: The associated item can still be found on the trait page. This PR emits the warn-by-default lint `unused_attribute` for this case with a future-incompat warning. `@rustbot` label T-compiler T-rustdoc A-lint |
||
|---|---|---|
| .. | ||
| alloc | ||
| boxed | ||
| collections | ||
| ffi | ||
| raw_vec | ||
| rc | ||
| sync | ||
| vec | ||
| alloc.rs | ||
| borrow.rs | ||
| boxed.rs | ||
| fmt.rs | ||
| lib.rs | ||
| macros.rs | ||
| raw_vec.rs | ||
| rc.rs | ||
| slice.rs | ||
| str.rs | ||
| string.rs | ||
| sync.rs | ||
| task.rs | ||
| tests.rs | ||