rustdoc doesn't detect + warn about broken anchor links, unlike regular intra-doc links
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Not sure what category this should be. This one is much more of a feature request, than a bug.
The term of what is meant by anchors is borrowed from here https://github.com/rust-lang/rust/issues/62833 .
cargo-deadlinks https://github.com/deadlinks/cargo-deadlinks does detect these, but is somewhat unofficial and is not as convenient to use as the rustdoc / cargo doc .
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 reading rustdoc and cargo doc behavior alongside issue #62833 and the detection provided by cargo-deadlinks. Identify how rustdoc validates regular intra-doc links, then define equivalent handling for broken anchor links; done means cargo doc or rustdoc warns about those broken anchors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100