AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Setup doctests to check Python snippets in docs

Aperta
#481 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Documentation Feature Request Needs Discussion
Lingua principale
C++
Stelle
2.1k
Fork
503
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Ideally #473 should have been caught by an automated tests (using doctest or similar)

http://www.sphinx-doc.org/en/stable/ext/doctest.html

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando l’issue #473 e la documentazione Sphinx doctest collegata per comprendere il problema segnalato nello snippet Python e l’approccio proposto. Trova il punto di ingresso della build della documentazione e determina come devono essere invocati i doctest; il lavoro è completato quando gli snippet della documentazione vengono controllati automaticamente e il problema segnalato viene rilevato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation, testing
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.