prometheus / prometheus/client_python
Enhancement request: better documentation
Offen
Dieses Issue hat noch niemand übernommen.
help wanted
- Vorherrschende Sprache
- Python
- Sterne
- 4.4k
- Forks
- 876
- Ø Merge
- 8 T. 4 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie damit, die vorhandene Dokumentation der Bibliothek und die API-Beschreibungen für Registry und collect zu prüfen. Ermitteln Sie, welchen öffentlichen APIs Erklärungen fehlen, und dokumentieren Sie den Zweck von Registry, wann collect aufgerufen wird und welchen Vertrag es hat. Die Aufgabe ist abgeschlossen, wenn die API-Dokumentation diese Fragen umfassend beantwortet.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100