prometheus / prometheus/client_python
enhancement: docstring to be RST friendly.
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 4.4k
- Forks
- 876
- Merge moyen
- 8 j 4 h
- PR mergées (30 j)
- 1
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la docstring de Metrics dans prometheus_client/metrics.py, autour de la ligne 516, et générez sa documentation avec Sphinx pour reproduire le problème de formatage. Le travail est terminé lorsque les docstrings de Metrics concernés génèrent leurs exemples de code sous forme de blocs de code RST plutôt que de blocs de citation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100