rust-lang / rust-lang/rust-clippy
Lint messages link to docs for 0.0.212 which does not include all available lints
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Currently, when installing Clippy on stable via Rustup, the links to the documentation in the lint output point to the documentation of 0.0.212.
That documentation does not include all the lints which are available in the distributed Clippy version.
So, when a newly added lint is triggered, opening the documentation link will not show the new lint, because it wasn't included in 0.0.212.
I can think of two solutions:
- Update the version of the
clippy_lintscrate before the rustc submodule is updated. - Use the short commit hash in the link, instead of the version.
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 at the Clippy lint output that generates documentation links and inspect how the clippy_lints version or short commit hash is selected. Done means stable Rustup links cover every lint available in the distributed Clippy version; validate with a newly added lint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100