[rustdoc] type aliases in function signatures can be confusing
Open
Nobody has claimed this yet.
C-discussion
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Location
https://doc.rust-lang.org/std/io/struct.Lines.html
Summary
https://doc.rust-lang.org/std/io/struct.Lines.html states that Lines::fmt has a return value of "Result"
whereas https://doc.rust-lang.org/std/fmt/trait.Debug.html#tymethod.fmt says that fmt has a return value of "Result<(),E>"
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
Use the linked Lines and Debug documentation pages as the entry points, and compare how the return types of their fmt methods are rendered. Trace the rustdoc source responsible for these signatures; done means the two related function signatures present consistent, unconfusing type information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100