PinDerefMutHelper should not show up in impl DerefMut for Pin
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Location (URL)
https://doc.rust-lang.org/nightly/std/pin/struct.Pin.html#impl-DerefMut-for-Pin%3CPtr%3E
Summary
The PR #145608 explicitly contains measures using #[cfg(doc)] to ensure that the docs are rendered in a certain way. This works locally, as can be seen from the locally generated docs in https://github.com/rust-lang/rust/pull/145608#issuecomment-3348597943, but on doc.rust-lang.org this does not seem to apply.
Perhaps --cfg doc is not applied when building docs for the website, even though they are applied locally?
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 with the Pin documentation URL and PR #145608, comparing the locally generated docs referenced there with the version on doc.rust-lang.org. Investigate whether the website's documentation build applies the documented #[cfg(doc)] measures, then verify that PinDerefMutHelper no longer appears in the impl DerefMut for Pin 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