Skip to content

rustdoc --show-coverage is poorly named #159691

Open

Description

@Urgau

With #159411, --show-coverage will respect -o (output flag).

As a result "show" will be a misnomer as it may not show anymore.

It was proposed to renamed it to --doc-coverage #159411 (comment).

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Jul 21, 2026
  2. added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Jul 21, 2026
  3. aDotInTheVoid commented on Jul 23, 2026

    @aDotInTheVoid
    Member

    I think the right thing is to do —output-format=coverage and —output-format=coverage-json. That way it’s clear that this is a “major mode” that means docs won’t be generated.

    This was discussed before, and there wasn’t consensus #159691.

  4. changed the title [-]rustdoc `--show-coverage` is miss named[/-] [+]rustdoc `--show-coverage` is poorly named[/+] on Aug 5, 2026
  5. added
    A-CLIArea: Command-line interface (CLI) to the compiler
    requires-nightlyThis issue requires a nightly compiler in some way. When possible, use a F-* label instead.
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    A-doc-coverageArea: Calculating how much of a crate has documentation
    and removed
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-CLIArea: Command-line interface (CLI) to the compilerA-doc-coverageArea: Calculating how much of a crate has documentationC-enhancementCategory: An issue proposing an enhancement or a PR with one.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.requires-nightlyThis issue requires a nightly compiler in some way. When possible, use a F-* label instead.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions