prometheus / prometheus/client_python
Improve documentation for Enum and Info classes
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 4.4k
- Forks
- 876
- Ø Merge
- 8 T. 4 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
In Instrumenting section of documentation (https://github.com/prometheus/client_python#instrumenting) there is written:
Four types of metric are offered: Counter, Gauge, Summary and Histogram.
Classes for exposing these metrics are then described and in addition there are mentioned also Info and Enum classes without explanation how these classes should be used and what type of metrics they expose. These should be documented in more detail.
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
Beginne im Dokumentationsabschnitt „Instrumenting“ des Repositorys und prüfe, wie die vorhandenen Metrikklassen beschrieben werden. Dokumentiere, wie die Klassen Info und Enum verwendet werden und welche Metriktypen sie bereitstellen; der Abschnitt ist vollständig, wenn beide Klassen Erklärungen haben, die mit denen der anderen Metriktypen vergleichbar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100