Documentation code blocks should be type checked as real tests
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 20.6k
- Forks
- 3.3k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
Feature
Ideally, if anyone has the time, documentation code blocks should be type checked as real tests
Pitch
This will ensure that the examples stay up to date and valid; provide an obvious home for basic test coverage where it can also inform the user; and, as an added bonus, necessarily implies fixing the issue about how the documentation test examples don't use real errors.
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
No se nombran archivos, pruebas ni puntos de entrada. Empieza por localizar cómo se prueban actualmente los bloques de código de la documentación y, después, determina cómo podrían comprobarse los tipos como pruebas reales. Se considerará terminado cuando los ejemplos de la documentación se comprueben para verificar su validez y se resuelva el issue vinculado sobre que los ejemplos no usan errores reales.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation, testing-qa
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100