Add test that fails/warns when methods are undocumented.
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- ci-cd, documentation, testing-qa
Línea de trabajo
Comienza localizando la configuración de compilación de la documentación de Doxygen y Sphinx; después, determina dónde podría un test de Python inspeccionar la salida de Doxygen y dónde podrían enviarse los resultados de la documentación a CDash. Se considera terminado cuando los métodos sin documentación producen un fallo o una advertencia en el test, y las advertencias y errores de compilación de Sphinx son visibles en el panel de CDash.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This could be done by writing a Python test that runs the Doxygen command and filters the output.
It would also be nice to "pass" warnings and errors from building the Sphinx user documentation to the CDash dashboard so that people realize when they have broken the documentation in some way.
- Lenguaje dominante
- C++
- Estrellas
- 59
- Forks
- 30
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Más de Kitware/SMTK
-
pybind11 gil_scoped_acquireAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
-
Building smtk statically breaks session registry.Quizá libre de nuevo @vibraphone la tomó hace 3960 días y no hay ningún pull request abierto. Abiertobug
-
Mangle third party librariesAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
MOAB header messAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 20/100
-
Clean up SMTK buildAbiertohelp wanted
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de Kitware/SMTK
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
gavinlouuu-kpt/mib-studio-qt#517 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
ws_bridge: stripping format=evr for matchmaker connections can concatenate the path and queryAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
EchoTools/nevr-runtime#116 ·
Los mantenedores suelen responder en 1 día
-
code-quality libc++
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
llvm/llvm-project#229284 ·
Los mantenedores suelen responder en 1 día
-
test-issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
llvm/offload-test-suite#1557 ·
Los mantenedores suelen responder en 1 día