Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support examples in README.md ? #16

Open
ms-ati opened this issue Oct 6, 2020 · 1 comment
Open

Support examples in README.md ? #16

ms-ati opened this issue Oct 6, 2020 · 1 comment
Labels
enhancement help wanted

Comments

@ms-ati
Copy link

ms-ati commented Oct 6, 2020

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!
@p0deje
Copy link
Owner

p0deje commented Oct 11, 2020

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

No, only Ruby files are supported.

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!

Maybe it can be added without much of a problem, I will merge PRs adding this. However, there is already https://github.com/zverok/dokaz which does this exactly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ms-ati @p0deje