Browse Source

Add note about JSON.parse not being spec compliant

RedMser 2 years ago
parent
commit
f225bfe28c
1 changed files with 5 additions and 0 deletions
  1. 5 0
      doc/classes/JSON.xml

+ 5 - 0
doc/classes/JSON.xml

@@ -28,6 +28,11 @@
 		[codeblock]
 		[codeblock]
 		var data = JSON.parse_string(json_string) # Returns null if parsing failed.
 		var data = JSON.parse_string(json_string) # Returns null if parsing failed.
 		[/codeblock]
 		[/codeblock]
+		[b]Note:[/b] Both parse methods do not fully comply with the JSON specification:
+		- Trailing commas in arrays or objects are ignored, instead of causing a parser error.
+		- New line and tab characters are accepted in string literals, and are treated like their corresponding escape sequences [code]\n[/code] and [code]\t[/code].
+		- Numbers are parsed using [method String.to_float] which is generally more lax than the JSON specification.
+		- Certain errors, such as invalid Unicode sequences, do not cause a parser error. Instead, the string is cleansed and an error is logged to the console.
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>