Clarified json_load_callback_t return value docs

This commit is contained in:
Phillip Howell
2013-09-13 16:35:39 -05:00
committed by Petri Lehtinen
parent 257a716073
commit db8ca3645f

View File

@@ -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