Skip to content

Rustdoc currently does not distinguish between public and private itemsΒ #87785

Closed
@pvshvp-oss

Description

@pvshvp-oss

Rustdoc currently does not label, mark, or otherwise separate private items to distinguish them from public items, when the --document-private-items command-line argument is passed. The generated documentation hence can be confusing to the reader. I suggest enabling one or more of the below through rustdoc:

  1. Separate public and private items in the generated documentation
  2. Enable toggling the visibility of private items in the generated documentation.
  3. Label or mark private items to clearly distinguish them from public items.

This issue was prompted by rust-lang/docs.rs#304 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-visibilityArea: Visibility / privacyC-feature-requestCategory: A feature request, i.e: not implemented / a PR.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions