Skip to content
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

Rustdoc (rustdoc_ng) should hide priv items and methods by default #9410

Closed
bluss opened this issue Sep 22, 2013 · 3 comments
Closed

Rustdoc (rustdoc_ng) should hide priv items and methods by default #9410

bluss opened this issue Sep 22, 2013 · 3 comments
Assignees

Comments

@bluss
Copy link
Member

bluss commented Sep 22, 2013

Rustdoc should hide private and should be private items like statics, functions, structs where priv or non-pub is effectively malfunctioning today.

Lots of non-pub methods, functions, structs are now showing up in the official Trunk documentation, and thanks to bugs it's possible to use some of these as well (for example std::hashmap::resize_at is can be called).

  • Documentation is easier to understand if only pub items are shown
  • We want to avoid users starting to rely on non-pub items.

Tag #8125

@alexcrichton
Copy link
Member

A good example of this is http://static.rust-lang.org/doc/master/std/hashmap/struct.HashMap.html, all of the methods at the top of the list shouldn't be there at all.

@alexcrichton
Copy link
Member

This may or may not be a lot easier to accomplish with the outcome of #8215

@ghost ghost assigned alexcrichton Sep 24, 2013
@alexcrichton
Copy link
Member

I'm actively working on this.

djkoloski pushed a commit to djkoloski/rust that referenced this issue Sep 21, 2022
Use macro callsite when creating `Sugg` helper

Closes rust-lang#9375

changelog: Improvement: [`collapsible_if`]: Suggestions now work with macros, by taking the call site into account.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants