rustdoc: `doc(inline)` is hidden by inner `doc(hidden)`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
See https://github.com/Rust-for-Linux/linux/issues/1242#issuecomment-5611513515
This may relate to how rustdoc determines whether to hide re-exported items.
The fix should be that once an entry has been explicitly exposed via doc(inline), subsequent ref to the entry should no longer be affected by hidden located down the chain.
BTW, I remember the code being a bit messy, was it refactored later?🤔
cc @ojeda @GuillaumeGomez @LeeSomm
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 linked Rust-for-Linux issue and comment, then trace rustdoc's handling of re-exported items involving doc(inline) and doc(hidden). Done means an entry explicitly exposed with doc(inline) remains visible even when a later reference in its chain is marked hidden.
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
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100