rust-lang / rust-lang/rust-clippy
Lint hand-written intra-rustdoc links
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Once rust-lang/rust#43466 lands, people will be able to write links directly to Rust items instead of hand-writing the links. We should consider at some point adding a lint that will look for links to items and lint to use the latter format instead.
Obviously, we'd want to wait before this is implemented in compiler land before linting, but it's good to add to the list.
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 checking whether rust-lang/rust#43466 has landed and how compiler support for direct Rust item links is exposed. Then locate Clippy's lint registration and rustdoc-related tests; done means a lint detects hand-written links to Rust items and recommends the direct-link format without flagging valid links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100