AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Setup doctests to check Python snippets in docs

Offen
#481 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Documentation Feature Request Needs Discussion
Vorherrschende Sprache
C++
Sterne
2.1k
Forks
503
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Prüfung von Issue #473 und der verlinkten Sphinx-doctest-Dokumentation, um den gemeldeten Fehler im Python-Snippet und den vorgeschlagenen Ansatz zu verstehen. Finde den Einstiegspunkt für den Dokumentations-Build und ermittle, wie doctests aufgerufen werden sollten; fertig ist die Aufgabe, wenn die Dokumentations-Snippets automatisch geprüft werden und das gemeldete Problem erkannt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation, testing
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.