rust-lang/rust-clippy

Document `pub` functions in `clippy_utils`

Ouverte

#15 569 ouverte le 26 août 2025

Voir sur GitHubGuide contributeur
 (11 commentaires) (0 réaction) (1 personne assignée)Rust (1 391 forks)batch import
good first issue

Métriques du dépôt

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

Description

Description

Quite a lot of functions in clippy_utils lack documentation. Ideally, the missing_docs lint should be enabled on this crate, except for selected entities such as the static path definitions in the paths module (which might be moved into a submodule).

Note: we are not looking for LLM generated verbose documentation.

Version

Additional Labels

@rustbot label "+good first issue"

Guide contributeur

Direction de recherche
Identifiez toutes les fonctions publiques dans la crate `clippy utils` qui manquent de documentation et ajoutez des commentaires de doc concis et écrits par un humain.
Stack technique
rust
Domaine
tooling
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90