p0deje/yard-doctest

Support examples in README.md ?

オープン

#16 opened on 2020/10/06

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Gherkin (17 件のフォーク)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (117 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

If the gem already supports testing examples in README.md, how do we set that up?

If not, since YARD does already process README.md, would it be at all possible to support this? Happy to implement it myself if guidance provided!

コントリビューターガイド

調査方針
YARDがREADME.mdをどのように処理し、yard doctestがソースコードからサンプルを抽出する方法を調査します。パーサーを拡張して、READMEファイル内のMarkdownコードブロックを処理できるようにします。
技術スタック
ruby
領域
documentationtesting
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
RubyYARD
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60