diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2015-04-29 15:13:51 +0200 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-05-01 01:20:39 +0200 |
| commit | 7639dd510ec13dd577677dce2a673f5046432903 (patch) | |
| tree | a325dd4be7b9eeffe938e12b76e997b2d3814035 /docs/src | |
| parent | 0db81a98ff4d42e680a2baa34727c8e73297d05b (diff) | |
| download | libuv-7639dd510ec13dd577677dce2a673f5046432903.tar.gz libuv-7639dd510ec13dd577677dce2a673f5046432903.zip | |
doc: fix uv_run(UV_RUN_DEFAULT) description
Saying uv_run() always returns zero is incorrect in the presence of
calls to uv_stop().
PR-URL: https://github.com/libuv/libuv/pull/337
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/loop.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/src/loop.rst b/docs/src/loop.rst index 203672bd..2a01d796 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -92,7 +92,9 @@ API specified mode: - UV_RUN_DEFAULT: Runs the event loop until there are no more active and - referenced handles or requests. Always returns zero. + referenced handles or requests. Returns non-zero if :c:func:`uv_stop` + was called and there are still active handles or requests. Returns + zero in all other cases. - UV_RUN_ONCE: Poll for i/o once. Note that this function blocks if there are no pending callbacks. Returns zero when done (no active handles or requests left), or non-zero if more callbacks are expected (meaning |