On 07/30/2014 11:21 AM, Iñaki Baz Castillo wrote: > 2014-07-29 19:36 GMT+02:00 Saúl Ibarra Corretgé <[email protected]>: >> The built documentation (updated with every commit) can be viewed here: >> http://libuv.readthedocs.org/ > > Question: Will that be a real documentation site? or just the uv.h in > cool HTML format? > > For example, the uv_stop(loop) documentation is 95% useless for a newcomer: >
It will be real documentation. I put together the site with the aim that others would help. The initial content is mostly uv.h with rewording plus some additions. Instead of dismissing other's efforts as "95% useless", send a PR with improvements. > ------------------ > void uv_stop(uv_loop_t* loop) > > Stop the event loop, causing uv_run() to end as soon as possible. This > will happen not sooner than the next loop iteration. If this function > was called before blocking for i/o, the loop won’t block for i/o on > this iteration. > ------------------ > > What is "before blocking for i/o"? when does that happen? That's about > UV internals. The user would expect that uv_stop() does all the magic > that, in fact, it does not. The documentation should kindly explain > that the user needs to iterate again the loop in order to free all the > resources and handles and so on. > The details on how the event loop works will be documented on the "Design overview" section, which is now marked as TODO, there are just 24 hours a day, you know. -- Saúl Ibarra Corretgé bettercallsaghul.com
signature.asc
Description: OpenPGP digital signature
