-
Notifications
You must be signed in to change notification settings - Fork 14k
Closed
Closed
Copy link
Labels
C-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
Consider a crate parent with the following items:
mod module;
#[doc(hidden)]
pub use module::Hidden;
pub use module::Visible;where module.rs contains:
pub enum Hidden { }
pub enum Visible { }Now consider a crate foo that inline, glob-exports parent in a module par:
extern crate parent;
pub mod par {
#[doc(inline)]
pub use parent::*;
}The item Hidden is rendered in the rustdocs for foo::par when it shouldn't be.
To work around this issue, #[doc(hidden)] can be applied to the Hidden item in module.rs:
#[doc(hidden)]
pub enum Hidden { }
pub enum Visible { }This workaround only works when #[doc(hidden)] is applied to the source definition.
Metadata
Metadata
Assignees
Labels
C-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.