rustdoc `--show-coverage` is poorly named
Open
Beginner friendly
Nobody has claimed this yet.
A-CLI
A-doc-coverage
C-enhancement
requires-nightly
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
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 https://github.com/rust-lang/rust/pull/159411#issuecomment-5008392399.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching rustdoc for the --show-coverage option and review the linked PR #159411, including its discussion of --doc-coverage. Rename the option consistently and update the relevant tests or help text; done means the new name is used and the old misnomer is no longer exposed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, compilers
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100