prometheus/client_python

Enhancement request: better documentation

Offen

#528 geöffnet am 12.03.2020

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (20 Reaktionen) (0 zugewiesene Personen)Python (732 Forks)batch import
help wanted

Repository-Metriken

Stars
 (3.404 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 7h) (4 gemergte PRs in 30 T)

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?

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Dokumentationsstruktur, identifizieren Sie fehlende API Dokumentationen für Klassen wie Registry und Methoden wie collect und schlagen Sie Verbesserungen vor. Befolgen Sie den Dokumentations Styleguide des Projekts.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80