AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Setup doctests to check Python snippets in docs
Đang mở
Documentation
Feature Request
Needs Discussion
- Ngôn ngữ chính
- C++
- Star
- 2.1k
- Fork
- 503
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Ideally #473 should have been caught by an automated tests (using doctest or similar)
http://www.sphinx-doc.org/en/stable/ext/doctest.html
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách xem xét issue #473 và tài liệu Sphinx doctest được liên kết để hiểu lỗi được báo cáo trong đoạn mã Python và phương án được đề xuất. Tìm điểm vào của quá trình build tài liệu và xác định cách cần gọi các doctest; được xem là hoàn thành khi các đoạn mã trong tài liệu được tự động kiểm tra và vấn đề được báo cáo được phát hiện.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation, testing
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 42/100