Skip to content

doc: inline collections at reexport module #67346

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
wants to merge 1 commit into from

Conversation

tesuji
Copy link
Contributor

@tesuji tesuji commented Dec 16, 2019

For example, when one searchs for "hashmap", there are two results returned.
This PR makes the result to contain only one.
https://imgur.com/TkkiEV6.png

@rust-highfive
Copy link
Contributor

r? @joshtriplett

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 16, 2019
@tesuji
Copy link
Contributor Author

tesuji commented Dec 16, 2019

r? @GuillaumeGomez

@GuillaumeGomez
Copy link
Member

Can you just provide a before/after screenshot please? It'll make it easier to check what's going for future readers. Once done I'll r+ it. :)

@tesuji
Copy link
Contributor Author

tesuji commented Dec 16, 2019

I built the rustdoc locally but things don't change before and after this PR.
I would close this PR if no one has any other suggestions to improve this.

pub use self::hash_map::HashMap;
#[stable(feature = "rust1", since = "1.0.0")]
#[doc(inline)]
pub use self::hash_set::HashSet;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there any doc attribute I could use to hide hash_map::HashMap from search
but leave item at hash_map::HashMap clickable?

Copy link
Member

Choose a reason for hiding this comment

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

It would require creating a new one. Do you mind creating an issue and tag the rustdoc team on it so we can discuss it please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I opened #67368 for discussion.

@tesuji
Copy link
Contributor Author

tesuji commented Dec 19, 2019

Closed for discussion in #67368.

@tesuji tesuji closed this Dec 19, 2019
@tesuji tesuji deleted the doc-inline-collections branch January 3, 2020 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants