code the documentation - Githubissues

AutoSponge / set-state

MIT License

6 stars 1 forks source link

code the documentation #3

Open AutoSponge opened 7 years ago

AutoSponge commented 7 years ago

I would prefer to have all methods carry their own jsdoc comments and use a parser to execute the examples as part of the test suite. So far, I can only find this functionality for mocha. I'm not switching out tape for mocha, so this may have to be invented.

TehShrike commented 6 years ago

I think you may be looking for jsmd, which will execute your readme examples and guarantee that they are correct.

AutoSponge commented 6 years ago

@TehShrike that looks great. I will look at hooking that up. Thanks for the suggestion!