Skip to content

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

Closed

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Oct 29, 2020

Part of #67368.

r? @jyn514

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 29, 2020
@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 29, 2020
@jyn514
Copy link
Member

jyn514 commented Oct 29, 2020

@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.

@GuillaumeGomez
Copy link
Member Author

Ah indeed, force of habit... I'll update my first comment. Good catch, thanks!

Comment on lines +3 to +5
#[doc(search_hidden)]
/// Foo
pub struct Bar;
Copy link
Member

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?

Suggested change
#[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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure!

@jyn514
Copy link
Member

jyn514 commented Nov 4, 2020

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.

@bors
Copy link
Collaborator

bors commented Nov 9, 2020

☔ 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:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

@JohnCSimon JohnCSimon added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 24, 2020
@jyn514 jyn514 added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 29, 2020
@camelid camelid added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Mar 12, 2021
@camelid camelid added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels May 28, 2021
@jyn514
Copy link
Member

jyn514 commented Jul 2, 2021

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.

@jyn514 jyn514 closed this Jul 2, 2021
@GuillaumeGomez GuillaumeGomez deleted the doc-search-hidden branch August 19, 2024 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-blocked Status: Blocked on something else such as an RFC or other implementation work. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants