RFE: consider adding man pages
Open
Nobody has claimed this yet.
E-help-wanted
P-low
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
It is generally expected that CLI programs on unix-like systems should have a man page. Elsewhere in the Rust toolchain, we do have rustc.1, rustdoc.1, cargo.1, and many cargo-*.1 subcommands. It seems reasonable that we could have rustfmt.1 and cargo-fmt.1 as well.
See also rust-lang/rust#98977 for discussion about autogenerating man pages.
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
Compare the existing rustc.1, rustdoc.1, cargo.1, and cargo-*.1 pages with the rustfmt and cargo-fmt command interfaces. Read the linked rust-lang/rust#98977 discussion about autogeneration; the work is complete when an agreed approach and scope for the two requested man pages is established.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100