prometheus/client_python

Enhancement request: better documentation

Open

#528 aperta il 12 mar 2020

Vedi su GitHub
 (3 commenti) (20 reazioni) (0 assegnatari)Python (732 fork)batch import
help wanted

Metriche repository

Star
 (3404 star)
Metriche merge PR
 (Merge medio 10g 7h) (4 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina la struttura della documentazione esistente, identifica la documentazione API mancante per classi come Registry e metodi come collect, e proponi miglioramenti. Segui la guida di stile della documentazione del progetto.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80