From c2e8fdde9d38c6fa3892e7bb37a3fc80d20e2fd4 Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Mon, 16 Sep 2013 08:48:54 +0300 Subject: [PATCH] Mention success first in json_load_callback_t docs --- doc/apiref.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/apiref.rst b/doc/apiref.rst index 9218cf8..25260e9 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -993,9 +993,10 @@ The following functions perform the actual JSON decoding. *buffer* points to a buffer of *buflen* bytes, and *data* is the corresponding :func:`json_load_callback()` argument passed through. - On error, the function should return ``(size_t)-1`` to abort the - decoding process. When there's no data left, it should return 0 to - report that the end of input has been reached. + On success, the function should return the number of bytes read; a + returned value of 0 indicates that no data was read and that the + end of file has been reached. On error, the function should return + ``(size_t)-1`` to abort the decoding process. .. versionadded:: 2.4