Man pages for new `cargo report *` commands
Open
Nobody has claimed this yet.
A-documenting-cargo-itself
C-feature-request
S-needs-design
Z-build-analysis
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
Problem
The new unstable commands
cargo report sessionscargo report rebuildscargo report timings
don't have their own command documentation like other commands.
We'll need to follow how we document cargo report future-incompatibilties in https://github.com/rust-lang/cargo/pull/16430 in order to document them.
Proposed Solution
Document these commands by the same approach of https://github.com/rust-lang/cargo/pull/16430.
Notes
Blocked on https://github.com/rust-lang/cargo/pull/16430.
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 reading PR 16430 and follow how cargo report future-incompatibilities receives command documentation. Add equivalent man-page documentation for cargo report sessions, rebuilds, and timings, then verify that each command has its own generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100