p0deje/yard-doctest

Support examples in README.md ?

Open

#16 opened on Oct 6, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Gherkin (17 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (117 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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!

Contributor guide

Research direction
Investigate how YARD processes README.md and how yard doctest currently extracts examples from source code. Possibly extend the parser to handle markdown code blocks in README files.
Tech stack
ruby
Domain
documentationtesting
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyYARD
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60