p0deje/yard-doctest

Support examples in README.md ?

开放

#16 创建于 2020年10月6日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人)Gherkin (17 个派生)github user discovery
enhancementhelp wanted

仓库指标

星标
 (117 个星标)
PR 合并指标
 (30 天内没有已合并 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
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
RubyYARD
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60