prometheus / prometheus/client_python
Improve documentation for Enum and Info classes
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
In Instrumenting section of documentation (https://github.com/prometheus/client_python#instrumenting) there is written:
Four types of metric are offered: Counter, Gauge, Summary and Histogram.
Classes for exposing these metrics are then described and in addition there are mentioned also Info and Enum classes without explanation how these classes should be used and what type of metrics they expose. These should be documented in more detail.
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 en la sección de documentación „Instrumenting“ del repositorio y revisa cómo se describen las clases de métricas existentes. Documenta cómo se utilizan las clases Info y Enum y qué tipos de métricas exponen; la sección estará completa cuando ambas clases tengan explicaciones comparables a las de los otros tipos de métricas.
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
- 45/100