prometheus / prometheus/client_python
enhancement: docstring to be RST friendly.
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 4.4k
- Forks
- 876
- Merge medio
- 8 d 4 h
- PR fusionados (30 d)
- 1
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el docstring de Metrics en prometheus_client/metrics.py, alrededor de la línea 516, y renderiza su documentación con Sphinx para reproducir el problema de formato. Se considera terminado cuando los docstrings de Metrics relevantes rendericen sus ejemplos de código como bloques de código RST en lugar de bloques de citas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100