Rust API Guideline: Function docs include error conditions in "Errors" section

Métriques du dépôt

Stars

10 406 stars (10 406 stars)

Métriques de merge PR

Merge moyen 19j 22h (Merge moyen 19j 22h)113 PRs mergées en 30 j (113 PRs mergées en 30 j)

Description

Guide contributeur

Direction de recherche

Consultez la directive de l'API Rust sur la documentation des conditions d'erreur. Trouvez les fonctions de lint Clippy qui n'ont pas de section 'Errors' dans leurs commentaires de documentation et ajoutez la.

Stack technique

rust

Domaine

documentationdeveloper experience

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.

Moins d'une heure

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

GitRust

Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.

85