Skip to content

rustdoc: Rename --show-coverage to --output-format coverage (and coverage-json) #84012

Open
@jyn514

Description

@jyn514

Right now, --output-format is greatly overloaded (as seen by #82497). --output-format json is unstable, except when you use it with --show-coverage. Also, --show-coverage is not great at conveying that it stops documentation from being generated at all.

I suggest that we rename --show-coverage to --output-format coverage and --show-coverage --output-format json to --output-format coverage-json, deprecate the old uses for a few releases, and then remove them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-doc-coverageArea: Calculating how much of a crate has documentationC-discussionCategory: Discussion or questions that doesn't represent real issues.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