[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- markdown, python
- 領域
- ci-cd, documentation, testing
調査の方向性
まず introduction.md、about.md、instruction.md を確認し、次に doctest、mkcodes、pmdoctest をそれぞれの fenced Python examples と比較します。文書化された fence を処理する戦略と、CI integration でそれらをどのように検証するかを定義します;合意したツールと評価パスが決まれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Python
- スター
- 2.5k
- フォーク
- 1.5k
- 平均マージ
- 2日 17時間
- マージ済み PR(30日)
- 2
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
exercism/python のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
[General Docs] Audit/Cleanup of Track General/Shared Docs対応中かも @Yrahcaz7 が 6 日前に担当しました。 オープン
-
[Decimals]: New Concept and Concept Exercise再び着手できるかも @BethanyG が 516 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
exercism/python の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
bug difficulty:2
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
MakazhanAlpamys/Soup#3167 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
snap-stanford/Biomni#380 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
jsboige/CoursIA#27768 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 66/100
rossant/awesome-math#206 ·