-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Add #[doc(search_hidden)] attribute #78525
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.
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
Conversation
@GuillaumeGomez if you want this to be stabilized at some point it needs a tracking issue. You made #67368 the tracking issue in the code but you also said 'fixes' in the commit. Either it needs a new issue or you need to not close the existing one. |
Ah indeed, force of habit... I'll update my first comment. Good catch, thanks! |
#[doc(search_hidden)] | ||
/// Foo | ||
pub struct Bar; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you also add a test that re-exports are still shown?
#[doc(search_hidden)] | |
/// Foo | |
pub struct Bar; | |
#[doc(search_hidden)] | |
/// Foo | |
pub struct Bar; | |
mod inner { | |
pub use Bar; | |
} |
and then update search_hidden.js
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure!
I think this feature doesn't make sense in isolation, I'd rather have doc(canonical): rust-lang/rfcs#3011. I'll try to write that up into a full RFC some time this week. |
☔ The latest upstream changes (presumably #78889) made this pull request unmergeable. Please resolve the merge conflicts. Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:
|
I'm going to close this; I don't think this feature makes sense to add. Happy to collaborate on an RFC for doc(canonical) but I probably won't work on it myself for a while. |
Part of #67368.
r? @jyn514