rustdoc thinks Deref extends to functions that use `Pin<&mut Self>`
Open
Nobody has claimed this yet.
A-associated-items
C-bug
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
If type A has a function with the self parameter Pin<&mut Self>, e.g. fn close(self: Pin<&mut Self>), and type B implements Deref<Target = A>, then those functions will be listed in type B's rustdoc in the "Methods from Deref<Target = A>" section. This is incorrect behavior because type B cannot access those functions through Deref.
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 reproducing the example with type A's fn close(self: Pin<&mut Self>) and type B's Deref<Target = A>, then inspect the rustdoc output for inherited methods. The work is done when functions requiring Pin<&mut Self> are no longer listed under B's "Methods from Deref<Target = A>" section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100