exercism / exercism/python

[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents

Đang mở
#2,848 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
discussion 💬
Ngôn ngữ chính
Python
Star
2.5k
Fork
1.5k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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](https://docs.python.org/3/library/doctest.html) - this is the old-school original, but doesn't really work well in markdown fences.
[mkcodes](https://github.com/ryneeverett/mkcodes) - have not tried this yet.
[pmdoctest](https://tmarktaylor.github.io/phmdoctest/) - reasonably good, but requires some weird quirks with code fence language names and or excess `>>>` in code fences to make parsing work.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.