rust-lang/rust-clippy

Configuring clippy in Cargo.toml missing from documentation?

Open

#12,164 opened on Jan 18, 2024

View on GitHub
 (9 comments) (2 reactions) (1 assignee)Rust (10,406 stars) (1,391 forks)batch import
A-documentationgood first issue

Description

Description

I don't know where did I see that Clippy can be configured in Cargo.toml, but I don't seem to find it anywhere in the documentation. I also searched for the word priority and it was only mentioned in the prioritization of tasks not related to how the lints are prioritized.

Version

No response

Additional Labels

No response

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust knowledgeFamiliarity with CLIppyUnderstanding of Cargo.toml
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the current CLIppy documentation at https://doc.rust lang.org/stable/clippy/index.html to identify where the configuration in Cargo.toml should be documented. Review RFC 3389 and the Cargo manifest lints section for authoritative details. Look at related issues #12161 and #12093 for context. The goal is to add a clear section explaining how to configure CLIppy lints and their priority via Cargo.toml.