From db8ca3645f95b292131d1a4c0f760f81a514cc3a Mon Sep 17 00:00:00 2001 From: Phillip Howell Date: Fri, 13 Sep 2013 16:35:39 -0500 Subject: [PATCH] Clarified json_load_callback_t return value docs --- doc/apiref.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/apiref.rst b/doc/apiref.rst index 9218cf8..3032d10 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -994,8 +994,9 @@ The following functions perform the actual JSON decoding. 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. + decoding process. On success, it 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. .. versionadded:: 2.4