rust-lang / rust-lang/rust-clippy
Unused links
Open
Nobody has claimed this yet.
A-lint
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
What it does
Detect docstrings containing unused link definitions.
This might be part of one of the rustdoc related lints, like clippy::doc_broken_link.
Advantage
No response
Drawbacks
No response
Example
/// Google.
///
/// [Google]: www.google.com
struct G;
Should detect that [Google] isn't being used.
Comparison with existing lints
No response
Additional Context
No response
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 the existing rustdoc-related lints, especially clippy::doc_broken_link, and compare their handling of link definitions. Use the provided Rust example as the behavior to validate: an unused [Google] definition should be detected while a referenced definition should not.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100