node-async-testing
node-async-testing copied to clipboard
started on api docs
hi
started on API docs, runSuite (which i've been using) should be correct, other functions I havn't tested yet so they may not be quite right.
although there are already some docs, I wanted to start pure API that are more rigorous that getting-started style stuff. Also, to thresh out what the interface is...
it's hard to work with an open source project when the interface is changing. we need a consistant, flexible and stable interface.
for example, I like that onSuiteDone is called for every different way that a suite can end, but it's difficult if an argument changes it's structure in different cases, unless there is a very good reason to do so...