Browse code

json: docs - more details about the result of json_get_field()

- reported by GH #1542

(cherry picked from commit 6a64100105e7ac0ae8a952a2e3770d7534615796)
(cherry picked from commit 5041f3483ee9d579e144f77f5e43e1e406121e8a)

Daniel-Constantin Mierla authored on 27/02/2018 12:10:19
Showing 1 changed files
... ...
@@ -63,6 +63,12 @@
63 63
 	    <para>
64 64
 		Copy field 'field_name' from json object 'json_string' and store it in pvar 'destination'.
65 65
 		</para>
66
+		<para>
67
+		Note that the result is the string representation of that JSON filed.
68
+		For example, if you want to retrieve a field that has a string value,
69
+		then the result is the value enclosed in quotes. If the field value is a structure,
70
+		then the result is the string-formatted representation of that structure.
71
+		</para>
66 72
 		<example>
67 73
 		<title><function>json_get_field</function> usage</title>
68 74
 		<programlisting format="linespecific">