doc: Clarify the result of 's' format of json_unpack()
authorPetri Lehtinen <petri@digip.org>
Mon, 12 Sep 2011 18:22:19 +0000 (21:22 +0300)
committerPetri Lehtinen <petri@digip.org>
Mon, 12 Sep 2011 18:22:20 +0000 (21:22 +0300)
Fixes GH-31.

doc/apiref.rst

index 4ea336f..b49861d 100644 (file)
@@ -997,7 +997,9 @@ type whose address should be passed.
 
 ``s`` (string) [const char \*]
     Convert a JSON string to a pointer to a NULL terminated UTF-8
-    string.
+    string. The resulting string is extracted by using
+    :func:`json_string_value()` internally, so it exists as long as
+    there are still references to the corresponding JSON string.
 
 ``n`` (null)
     Expect a JSON null value. Nothing is extracted.