rust-lang/rust-clippy

Split `missing_docs_in_private_items` into various lints

Open

#5 736 ouverte le 22 juin 2020

Voir sur GitHub
 (7 commentaires) (6 réactions) (0 assignés)Rust (1 391 forks)batch import
C-enhancementgood first issue

Métriques du dépôt

Stars
 (10 406 stars)
Métriques de merge PR
 (Merge moyen 19j 22h) (113 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Étudiez l'implémentation existante du lint `missing docs in private items`, puis créez de nouveaux lints pour les champs, variantes, modules, etc., en suivant les directives de contribution de clippy.
Stack technique
rust
Domaine
tooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustClippy linting basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60