[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- markdown, python
- Lĩnh vực
- ci-cd, documentation, testing
Hướng nghiên cứu
Bắt đầu bằng việc xem xét introduction.md, about.md và instruction.md, sau đó so sánh doctest, mkcodes và pmdoctest với các fenced Python examples tương ứng. Xác định chiến lược nào xử lý các fence được ghi lại trong tài liệu và việc tích hợp CI sẽ kiểm tra chúng như thế nào; được xem là hoàn thành khi đã thống nhất một công cụ và quy trình đánh giá.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation.
We currently "hand validate" example python code used in introduction.md, about.md, and instruction.md and similar documents. This leads to errors where certain code will not work in the REPL, or syntax or other errors get made and published. As we scale up exercises, this doesn't feel like a sustainable solution, hence this issue to propose, evaluate, and track possible tools and strategies for verifying code , and (possibly) adding that verification to the track CI.
Below are three applicable libraries, but I'd warmly welcome more. Of the three below, pmdoctest feels like the nicest solution, and I've run the comparisons concept exercise through it with reasonable results. But I'd like to see if there are other strategies/libraries out there.
doctest - this is the old-school original, but doesn't really work well in markdown fences.
mkcodes - have not tried this yet.
pmdoctest - reasonably good, but requires some weird quirks with code fence language names and or excess >>> in code fences to make parsing work.
- Ngôn ngữ chính
- Python
- Star
- 2.5k
- Fork
- 1.5k
- Merge trung bình
- 2 ngày 17 giờ
- Pull request đã merge (30 ngày)
- 2
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của exercism/python
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 75/100
-
Current status of approachesĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 35/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
-
[General Docs] Audit/Cleanup of Track General/Shared DocsCó thể đã có người làm @Yrahcaz7 đã nhận 6 ngày trước. Đang mở
-
[Decimals]: New Concept and Concept ExerciseCó thể làm lại được @BethanyG đã nhận 516 ngày trước và không có pull request nào đang mở. Đang mở
Tất cả issue của exercism/python
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
bug difficulty:2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
MakazhanAlpamys/Soup#3167 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
snap-stanford/Biomni#380 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
jsboige/CoursIA#27768 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Resource]: Math ParadoxesĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 66/100
rossant/awesome-math#206 ·