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] Hide impl block containing only private items by default #100001

Closed
jhpratt opened this issue Jul 31, 2022 · 1 comment · Fixed by #100323
Closed

[rustdoc] Hide impl block containing only private items by default #100001

jhpratt opened this issue Jul 31, 2022 · 1 comment · Fixed by #100323
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jhpratt
Copy link
Member

jhpratt commented Jul 31, 2022

Zulip thread where this was discussed

cc @GuillaumeGomez

@rustbot label +A-docs +A-rustdoc-ui +C-enhancement +T-rustdoc

This is technically a regression, but it doesn't feel appropriate to label it as such.

@rustbot rustbot added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 31, 2022
@jyn514
Copy link
Member

jyn514 commented Jul 31, 2022

Here is an example of a block that should be hidden when --document-private-items is not passed:

pub struct S;

/// Some docs here
impl S {
  fn foo() {}
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
4 participants