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:

------------------
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.


-- 
Iñaki Baz Castillo
<[email protected]>

-- 
You received this message because you are subscribed to the Google Groups 
"libuv" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/libuv.
For more options, visit https://groups.google.com/d/optout.

Reply via email to