AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Setup doctests to check Python snippets in docs
Abierto
Documentation
Feature Request
Needs Discussion
- Lenguaje dominante
- C++
- Estrellas
- 2.1k
- Forks
- 503
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Ideally #473 should have been caught by an automated tests (using doctest or similar)
http://www.sphinx-doc.org/en/stable/ext/doctest.html
Guía de contribución
Línea de trabajo
Empieza revisando el issue #473 y la documentación de Sphinx doctest enlazada para entender el fallo notificado del fragmento de Python y el enfoque propuesto. Encuentra el punto de entrada del build de la documentación y determina cómo deben invocarse los doctests; se considera terminado cuando los fragmentos de la documentación se comprueban automáticamente y se detecta el problema notificado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation, testing
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100