Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

enhancement: docstring to be RST friendly.

Abierto
#848 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

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.

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.

Lenguaje dominante
Python
Estrellas
4.4k
Forks
876
Merge medio
8 d 4 h
PR fusionados (30 d)
1

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de prometheus/client_python

Todos los issues de prometheus/client_python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.