From 7639dd510ec13dd577677dce2a673f5046432903 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Wed, 29 Apr 2015 15:13:51 +0200 Subject: [PATCH] doc: fix uv_run(UV_RUN_DEFAULT) description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- docs/src/loop.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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