AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Setup doctests to check Python snippets in docs

オープン
#481 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
Documentation Feature Request Needs Discussion
主要言語
C++
スター
2.1k
フォーク
503
PR マージ指標
30日以内にマージされた PR はありません

説明

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

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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず issue #473 とリンクされている Sphinx doctest のドキュメントを確認し、報告された Python スニペットの失敗と提案されているアプローチを理解します。ドキュメントの build のエントリーポイントを見つけ、doctest をどのように呼び出すべきかを判断します。ドキュメントのスニペットが自動的にチェックされ、報告された問題が検出されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation, testing
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。