AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Setup doctests to check Python snippets in docs

Ouverte
#481 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Documentation Feature Request Needs Discussion
Langage dominant
C++
Étoiles
2.1k
Forks
503
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner l’issue #473 et la documentation Sphinx doctest liée afin de comprendre l’échec signalé de l’extrait Python et l’approche proposée. Trouvez le point d’entrée du build de la documentation et déterminez comment les doctests doivent être invoqués ; le travail est terminé lorsque les extraits de documentation sont vérifiés automatiquement et que le problème signalé est détecté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation, testing
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.