From 4f3cc524265063d824d993fec6c834d015ee2653 Mon Sep 17 00:00:00 2001 From: skyace65 Date: Wed, 19 Jan 2022 20:37:58 -0500 Subject: [PATCH] Better explain JSON print indent parameter (3.x) (cherry picked from commit c540a17efc56ebd45114bdc2f795b28dae169726) --- doc/classes/JSON.xml | 42 +++++++++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index f51dd5fb8f1..7642f1c4b46 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -24,7 +24,7 @@ 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. + The [code]indent[/code] parameter controls if and how something is indented, the string used for this parameter will be used where there should be an indent in the output, even spaces like [code]" "[/code] will work. [code]\t[/code] and [code]\n[/code] can also be used for a tab indent, or to make a newline for each indent respectively. [b]Example output:[/b] [codeblock] ## JSON.print(my_dictionary) @@ -32,18 +32,34 @@ ## 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" - } - ] + "name": "my_dictionary", + "version": "1.0.0", + "entities": [ + { + "name": "entity_0", + "value": "value_0" + }, + { + "name": "entity_1", + "value": "value_1" + } + ] + } + + ## JSON.print(my_dictionary, "...") + { + ..."name": "my_dictionary", + ..."version": "1.0.0", + ..."entities": [ + ......{ + ........."name": "entity_0", + ........."value": "value_0" + ......}, + ......{ + ........."name": "entity_1", + ........."value": "value_1" + ......} + ...] } [/codeblock]