rustdoc: Tracking issue for improved path handling
Open
Nobody has claimed this yet.
C-tracking-issue
metabug
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
looking through old rustdoc issue, there's a common theme of wanting to display or act on an item's canonical path instead of just its name.
unfortunately, this information is not easily available to the librustdoc render logic.
- https://github.com/rust-lang/rust/issues/105307
- https://github.com/rust-lang/rust/issues/45260
- https://github.com/rust-lang/rust/issues/130189
- https://github.com/rust-lang/rust/issues/84367 (has more to do with canon names than paths, but still related)
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 reviewing the linked issues, especially #105307, #45260, #130189, and #84367, then inspect the librustdoc render logic mentioned in the issue. The work is complete when that logic can access an item's canonical path for the related display or behavior improvements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100