prometheus / prometheus/client_python
enhancement: docstring to be RST friendly.
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
This is probably not a bug, but I'm just wondering whether there is a decision not to make docstring for metrics RST-friendly.
Let's take the documentation for https://github.com/prometheus/client_python/blob/db391dbc83df4202698a21463ae89d6fb3611ce2/prometheus_client/metrics.py#L516 as an example.
The code block will not be rendered as a code block but as a quotes block when using Sphinx.
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 mit dem Metrics-Docstring in prometheus_client/metrics.py ungefähr bei Zeile 516 und rendere seine Dokumentation mit Sphinx, um das Formatierungsproblem zu reproduzieren. Als abgeschlossen gilt die Aufgabe, wenn die relevanten Metrics-Docstrings ihre Codebeispiele als RST-Codeblöcke statt als Zitatblöcke rendern.
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
- 35/100