rust-lang / rust-lang/rust-clippy
Lint non-code syntax for variables in documentation comments
Open
Nobody has claimed this yet.
C-an-interesting-project
S-needs-discussion
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Here:
/// This function adds a with `b`.
fn add(a: u32, b: u32) -> u32 { a + b };
note how in the documentation comment 'b' is quoted but a is not. We should lint about these.
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 locating where rust-clippy parses and lints documentation comments, then find the relevant test coverage. Use the Rust example in the issue as the initial case: the documentation comment quotes b but not a. Done means the lint consistently reports the inconsistent variable references in documentation comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100