From b62872d5bc89db25a6a8faf40a6e9f03d94e63e6 Mon Sep 17 00:00:00 2001 From: Thakee Nathees Date: Thu, 13 Aug 2020 11:35:33 +0530 Subject: [PATCH] Documentation: clarify the indent parameter of JSON.print (cherry picked from commit 3609351788121c1f94c06b198f5a6e94c7d3d22f) --- doc/classes/JSON.xml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index fa519152922..0eb7a93e955 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -30,6 +30,28 @@ 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]