From e4cc77ce52894d43a94c30d4ffbe7640a9e62a32 Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Mon, 12 Sep 2011 21:22:19 +0300 Subject: [PATCH] doc: Clarify the result of 's' format of json_unpack() Fixes GH-31. --- doc/apiref.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/apiref.rst b/doc/apiref.rst index 4ea336f..b49861d 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -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. -- 2.7.4