diff options
| author | Phillip Howell <phowell@vorne.com> | 2013-09-13 16:35:39 -0500 |
|---|---|---|
| committer | Petri Lehtinen <petri@digip.org> | 2013-09-19 20:47:02 +0300 |
| commit | db8ca3645f95b292131d1a4c0f760f81a514cc3a (patch) | |
| tree | c21f8ee36527d2895cb7f00023e5ebbed5d59e3f | |
| parent | 257a7160734854b6ceaea04096b4dd9410fe9645 (diff) | |
| download | jansson-db8ca3645f95b292131d1a4c0f760f81a514cc3a.zip jansson-db8ca3645f95b292131d1a4c0f760f81a514cc3a.tar.gz jansson-db8ca3645f95b292131d1a4c0f760f81a514cc3a.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 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 |