Skip to content

rustdoc: #[doc(hidden)] attribute on trait method implemention causes it to be "unhidden" #55686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
QuietMisdreavus opened this issue Nov 5, 2018 · 5 comments
Closed

rustdoc: #[doc(hidden)] attribute on trait method implemention causes it to be "unhidden" #55686

QuietMisdreavus opened this issue Nov 5, 2018 · 5 comments
Assignees
@GuillaumeGomez
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@QuietMisdreavus
Copy link
Member

While investigating #36035, i noticed that that sample looked a bit odd:

image

If you remove the #[doc(hidden)] from the implementation, the fn hidden() goes back under the "hidden undocumented items" section.

cc @GuillaumeGomez
@QuietMisdreavus QuietMisdreavus added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 5, 2018
@GuillaumeGomez GuillaumeGomez self-assigned this Nov 5, 2018
@GuillaumeGomez
Copy link
Member

You mean it should be in the "hidden undocumented items" section?

@QuietMisdreavus
Copy link
Member Author

Yes, but the situation may be more complicated than it seems. I left a longer comment in the issue i linked in the OP (#36035 (comment)) that describes what i think is going on.

@steveklabnik
Copy link
Member

Triage: any chance you've got the code that reproduces this issue?

@fmease
Copy link
Member

fmease commented Jul 27, 2022

The Show hidden undocumented items subsection does not exist anymore in today's rustdoc, right?
So this issue is essentially fixed.

@GuillaumeGomez
Copy link
Member

Indeed. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@steveklabnik @GuillaumeGomez @QuietMisdreavus @fmease