rust-lang / rust-lang/rust-clippy

Specify whether false-positives are expected in docs

Open
#2,680 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-documentation
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

I've run into lints that are false positives on clippy, but I've been unsure if they're expected or not. I think it would be helpful if the lints in the clippy collection (that are expected no false positives) showed something like:

We expected this lint, `lint_name_here` to have no false positives. If you found one, please report it! https://...../issues/false-positive-template

This could be both in the online docs (perhaps a label/button: No false positives. Found One? in the header line of the lint), as well as in the command line output.

Happy to make the changes if people are amenable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the online documentation for lints in the clippy collection and the code responsible for command-line lint output. Check how lint metadata and documentation headers are represented, then define the expected wording and false-positive report link for applicable lints. Done means the notice appears consistently in both the relevant online docs and CLI output.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.