diff options
| author | Saúl Ibarra Corretgé <saghul@gmail.com> | 2016-06-18 18:57:12 +0200 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2016-06-22 01:23:12 +0200 |
| commit | cdccd4f9900eaf123e1e70bca7e13e115f576bb8 (patch) | |
| tree | ac07e01fd9c3696f36bfe76b76bef08c04f1872e /docs/src/errors.rst | |
| parent | d75e334e34487575bcb46f6311fefbdc4849a564 (diff) | |
| download | libuv-cdccd4f9900eaf123e1e70bca7e13e115f576bb8.tar.gz libuv-cdccd4f9900eaf123e1e70bca7e13e115f576bb8.zip | |
doc: clarify callbacks won't be called in error case
PR-URL: https://github.com/libuv/libuv/pull/918
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'docs/src/errors.rst')
| -rw-r--r-- | docs/src/errors.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/src/errors.rst b/docs/src/errors.rst index cec25f51..2ebaf1e4 100644 --- a/docs/src/errors.rst +++ b/docs/src/errors.rst @@ -8,6 +8,9 @@ In libuv errors are negative numbered constants. As a rule of thumb, whenever there is a status parameter, or an API functions returns an integer, a negative number will imply an error. +When a function which takes a callback returns an error, the callback will never +be called. + .. note:: Implementation detail: on Unix error codes are the negated `errno` (or `-errno`), while on Windows they are defined by libuv to arbitrary negative numbers. |