diff options
| author | Thakee Nathees <thakeenathees@gmail.com> | 2020-08-13 11:35:33 +0530 |
|---|---|---|
| committer | Thakee Nathees <thakeenathees@gmail.com> | 2020-08-13 11:35:33 +0530 |
| commit | 3609351788121c1f94c06b198f5a6e94c7d3d22f (patch) | |
| tree | 48e65f5b127301a34e32d03c605292bf9fe62627 | |
| parent | ec678c5e94ac1c91c099c15fabc398e80ede7bfe (diff) | |
Documentation: clarify the indent parameter of JSON.print
| -rw-r--r-- | doc/classes/JSON.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 2e837dea1d..a9fb50c262 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -30,6 +30,28 @@ <description> Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. + Use [code]indent[/code] parameter to pretty print the output. + [b]Example output:[/b] + [codeblock] + ## JSON.print(my_dictionary) + {"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]} + + ## JSON.print(my_dictionary, "\t") + { + "name": "my_dictionary", + "version": "1.0.0", + "entities": [ + { + "name": "entity_0", + "value": "value_0" + }, + { + "name": "entity_1", + "value": "value_1" + } + ] + } + [/codeblock] </description> </method> </methods> |