diff options
| author | Phillip Howell <phowell@vorne.com> | 2013-09-13 16:35:39 -0500 |
|---|---|---|
| committer | Petri Lehtinen <petri@digip.org> | 2013-09-16 08:49:38 +0300 |
| commit | 0747d3943ff48db0a66e2c523bb79d1a6e525969 (patch) | |
| tree | 76e125f27ea653f7a2b3a8ba1522e94ec2346786 | |
| parent | 5f9ef108d046c3155851110ace3f2144c5acb05a (diff) | |
| download | jansson-0747d3943ff48db0a66e2c523bb79d1a6e525969.zip jansson-0747d3943ff48db0a66e2c523bb79d1a6e525969.tar.gz jansson-0747d3943ff48db0a66e2c523bb79d1a6e525969.tar.bz2 | |
Clarified json_load_callback_t return value docs
| -rw-r--r-- | doc/apiref.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst index 4127a85..af79ba8 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -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 |