diff options
| author | Petri Lehtinen <petri@digip.org> | 2013-09-16 08:48:54 +0300 |
|---|---|---|
| committer | Petri Lehtinen <petri@digip.org> | 2013-09-16 08:49:38 +0300 |
| commit | 24c67966aab09d929f944ca4f786e0f60ec4e10e (patch) | |
| tree | 70e6740b8729eb7fb3b3cd18591c9fb373d3a651 | |
| parent | 0747d3943ff48db0a66e2c523bb79d1a6e525969 (diff) | |
| download | jansson-24c67966aab09d929f944ca4f786e0f60ec4e10e.zip jansson-24c67966aab09d929f944ca4f786e0f60ec4e10e.tar.gz jansson-24c67966aab09d929f944ca4f786e0f60ec4e10e.tar.bz2 | |
Mention success first in json_load_callback_t docs
| -rw-r--r-- | doc/apiref.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst index af79ba8..cc3226f 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -1030,10 +1030,10 @@ The following functions perform the actual JSON decoding. *buffer* points to a buffer of *buflen* bytes, and *data* is the corresponding :func:`json_load_callback()` argument passed through. - On error, the function should return ``(size_t)-1`` to abort the - 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. + On success, the function 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. On error, the function should return + ``(size_t)-1`` to abort the decoding process. .. versionadded:: 2.4 |