projects
/
jansson.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
636d5f6
)
docs: Add a note that object iteration doesn't give any particular order
author
Petri Lehtinen
<petri@digip.org>
Sat, 14 May 2011 10:04:35 +0000
(13:04 +0300)
committer
Petri Lehtinen
<petri@digip.org>
Sat, 14 May 2011 10:04:35 +0000
(13:04 +0300)
Closes GH-15.
doc/apiref.rst
patch
|
blob
|
history
diff --git
a/doc/apiref.rst
b/doc/apiref.rst
index
6dfe839
..
438cfdd
100644
(file)
--- a/
doc/apiref.rst
+++ b/
doc/apiref.rst
@@
-563,7
+563,10
@@
Unicode string and the value is any JSON value.
existing keys. Returns 0 on success or -1 on error.
existing keys. Returns 0 on success or -1 on error.
-The following functions implement an iteration protocol for objects:
+The following functions implement an iteration protocol for objects,
+allowing to iterate through all key-value pairs in an object. The
+items are not returned in any particular order, as this would require
+sorting due to the internal object representation.
.. function:: void *json_object_iter(json_t *object)
.. function:: void *json_object_iter(json_t *object)