rust-lang/rust-clippy

Split `missing_docs_in_private_items` into various lints

Open

#5736 aperta il 22 giu 2020

Vedi su GitHub
 (7 commenti) (6 reazioni) (0 assegnatari)Rust (1391 fork)batch import
C-enhancementgood first issue

Metriche repository

Star
 (10.406 star)
Metriche merge PR
 (Merge medio 19g 22h) (113 PR mergiate in 30 g)

Descrizione

Would it be feasible and acceptable to split missing_docs_in_private_items into a few different lints? I find myself quite frequently adding #[allow] to enum variants and struct fields, in large part because the naming is typically self-explanatory. Even splitting the lint in two (fields/variants and everything else) would be incredibly useful for me, and would avoid cluttering declarations with unnecessary (imo) #[allow] attributes.

Having different lints for modules and top-level crate documentation would also be great, but are less important to me.

Guida contributor

Direzione di ricerca
Studia l'implementazione esistente del lint `missing docs in private items`, quindi crea nuovi lint per campi, varianti, moduli, ecc., seguendo le linee guida per i contributi di clippy.
Tech stack
rust
Dominio
tooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RustClippy linting basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60