Browse Source

[DOCS] JSON: Small fixes

Max Hilbrunner 7 years ago
parent
commit
a187345603
2 changed files with 6 additions and 6 deletions
  1. 1 1
      doc/classes/JSON.xml
  2. 5 5
      doc/classes/JSONParseResult.xml

+ 1 - 1
doc/classes/JSON.xml

@@ -4,7 +4,7 @@
 		Helper class for parsing JSON data.
 	</brief_description>
 	<description>
-		Helper class for parsing JSON data.
+		Helper class for parsing JSON data. For usage example, see [JSONParseResult].
 	</description>
 	<tutorials>
 	</tutorials>

+ 5 - 5
doc/classes/JSONParseResult.xml

@@ -14,23 +14,23 @@
 	</methods>
 	<members>
 		<member name="error" type="int" setter="set_error" getter="get_error" enum="Error">
-			The error type if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants.
+			The error type if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants.
 		</member>
 		<member name="error_line" type="int" setter="set_error_line" getter="get_error_line">
 			The line number where the error occurred if JSON source was not successfully parsed.
 		</member>
 		<member name="error_string" type="String" setter="set_error_string" getter="get_error_string">
-			The error message if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants.
+			The error message if JSON source was not successfully parsed. See [@GlobalScope] ERR_* constants.
 		</member>
 		<member name="result" type="Variant" setter="set_result" getter="get_result">
-			A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned.
+			A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned.
 			[i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i]
 			[codeblock]
 			p = JSON.parse('["hello", "world", "!"]')
 			if typeof(p) == TYPE_ARRAY:
-				print(p[0]) # prints 'hello'
+			    print(p[0]) # prints 'hello'
 			else:
-				print("unexpected results")
+			    print("unexpected results")
 			[/codeblock]
 		</member>
 	</members>