Add test that fails/warns when methods are undocumented.
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- ci-cd, documentation, testing-qa
Direzione di ricerca
Inizia individuando la configurazione di build della documentazione Doxygen e Sphinx, quindi determina dove un test Python potrebbe ispezionare l'output di Doxygen e dove potrebbero essere inviati a CDash i risultati della documentazione. Il lavoro è completato quando i metodi non documentati producono un errore o un avviso del test e gli avvisi e gli errori della build Sphinx sono visibili nella dashboard di CDash.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- C++
- Stelle
- 59
- Fork
- 30
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Kitware/SMTK
-
pybind11 gil_scoped_acquireAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
-
Building smtk statically breaks session registry.Forse di nuovo libera @vibraphone l’ha presa 3960 giorni fa e non c’è nessuna pull request aperta. Apertabug
-
Mangle third party librariesAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
MOAB header messAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 20/100
-
Clean up SMTK buildApertahelp wanted
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Tutte le issue di Kitware/SMTK
Issue simili
-
code-quality libc++
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
llvm/llvm-project#229284 ·
I maintainer di solito rispondono entro 1 giorno
-
test-issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
llvm/offload-test-suite#1557 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
iOS: hidden scale bar invalidates its intrinsic content size on every layout pass of MLNMapViewAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
maplibre/maplibre-native#4723 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
HarbourMasters/Shipwright#7320 ·
I maintainer di solito rispondono entro 1 giorno