News for hackers. Stuff that matters.
Re:Things People Hate about Your Open Source Docs by gleb_bahmutov on Friday June 21, 2013 @11:54AM (#5918666)
Lack of examples is the major problem, since it is hard to maintain examples in sync with the code. I created tool https://npmjs.org/package/xplain that transforms unit tests (javascript) into human readable examples in the API docs. Makes lots of up-to-date examples in the docs possible without any penalty.

There are no comments on this comment yet.