yard-doctest icon indicating copy to clipboard operation
yard-doctest copied to clipboard

Published 20 hours ago • verified publisher icon p0deje

Support examples in README.md ?

Open ms-ati opened this issue 5 years ago • 1 comments

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!

ms-ati avatar Oct 06 '20 15:10 ms-ati

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.

p0deje avatar Oct 11 '20 13:10 p0deje