FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarified json_load_callback_t return value docs

Browse Source
This commit is contained in:
Phillip Howell 2013-09-13 16:35:39 -05:00 committed by Petri Lehtinen
parent 5f9ef108d0
commit 0747d3943f
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/apiref.rst
View File

@ -1031,8 +1031,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