prometheus/client_python

Enhancement request: better documentation

Ouverte

#528 ouverte le 12 mars 2020

Voir sur GitHubGuide contributeur
 (3 commentaires) (20 réactions) (0 personne assignée)Python (732 forks)batch import
help wanted

Métriques du dépôt

Stars
 (3 404 étoiles)
Métriques de merge PR
 (Merge moyen 10j 7h) (4 PRs mergées en 30 j)

Description

The documentation for this library is incomplete. It could really use some thorough API documentation. For example, what is a Registry? When does the collect method get called, and what is its contract?

Guide contributeur

Direction de recherche
Examinez la structure de documentation existante, identifiez la documentation API manquante pour des classes comme Registry et des méthodes comme collect, et proposez des améliorations. Suivez le guide de style de documentation du projet.
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
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80