aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2013-09-16 08:48:54 +0300
committerPetri Lehtinen <petri@digip.org>2013-09-19 20:47:17 +0300
commitbf2584703a486af36190ecd20c529dbf7b0f4310 (patch)
tree64f26a17de035d473203d79c0e0a1288de269c5c
parentdb8ca3645f95b292131d1a4c0f760f81a514cc3a (diff)
downloadjansson-2.4.zip
jansson-2.4.tar.gz
jansson-2.4.tar.bz2
Mention success first in json_load_callback_t docs2.4
-rw-r--r--doc/apiref.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst
index 3032d10..25260e9 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -993,10 +993,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