FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add a note that object iteration doesn't give any particular order

Browse Source 
Closes GH-15.
This commit is contained in:
Petri Lehtinen 2011-05-14 13:04:35 +03:00
parent 636d5f60f9
commit ab723c7fb5
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/apiref.rst
View File

@ -563,7 +563,10 @@ Unicode string and the value is any JSON value.
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)