document-hidden-items should show when items are hidden #122485
Labels
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
Manishearth
added
the
T-rustdoc
rustbot
added
the
needs-triage
jieyouxu
added
C-enhancement
|
I think it's a pretty good idea. 👍 |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this issue
Mar 15, 2024
…meGomez Visually mark 👻hidden👻 items with document-hidden-items Fixes rust-lang#122485 This adds a 👻 in the item list (much like the 🔒 used for private items), and also shows `#[doc(hidden)]` in the code view, where `pub(crate)` etc gets shown for private items. This does not do anything for enum variants, if people have ideas. I think we can just show the attribute.
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Mar 15, 2024
Rollup merge of rust-lang#122495 - Manishearth:rustdoc-👻👻👻, r=GuillaumeGomez Visually mark 👻hidden👻 items with document-hidden-items Fixes rust-lang#122485 This adds a 👻 in the item list (much like the 🔒 used for private items), and also shows `#[doc(hidden)]` in the code view, where `pub(crate)` etc gets shown for private items. This does not do anything for enum variants, if people have ideas. I think we can just show the attribute.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
document-private-items shows a
pub(crate)/ empty on methods, and a 🔒 on types in the module interface.We should do the same for hidden items with document-hidden-items, perhaps showing
#[doc(hidden)]on methods and a 👻 in the types list.Thoughts?
(n.b. document-hidden-items is currently
-Zunstable-options)The text was updated successfully, but these errors were encountered: