Add "raises <exception type>" to docstrings

Métriques du dépôt

Stars

1 296 étoiles (1 296 étoiles)

Métriques de merge PR

Merge moyen 19j 5h (Merge moyen 19j 5h)6 PRs mergées en 30 j (6 PRs mergées en 30 j)

Description

Guide contributeur

Direction de recherche

Examinez les docstrings dans le code du client Python, en particulier les méthodes pouvant lever des exceptions. Ajoutez des descriptions `:raises ExceptionType:` en suivant le style de docstring existant.

Stack technique

python

Domaine

documentation

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.

2

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

GitPython

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

75