diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-12-13 22:32:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-13 22:32:35 +0100 |
| commit | 592ce20fc506e6b8a74f84515508cfc137aa75cf (patch) | |
| tree | 59175c2026ae28efc899b6da3e813523b7ff8287 | |
| parent | 8771329f5554f74320f21aa2e1620f9ba1d6f044 (diff) | |
| parent | a187345603ab406e11ec09414d80409d0b8c49da (diff) | |
Merge pull request #14638 from mhilbrunner/patch-7
[DOCS] JSON: Small fixes
| -rw-r--r-- | doc/classes/JSON.xml | 2 | ||||
| -rw-r--r-- | doc/classes/JSONParseResult.xml | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index bb48833878..28f04c3eb0 100644 --- a/doc/classes/JSON.xml +++ b/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> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 77145eff6a..835920818a 100644 --- a/doc/classes/JSONParseResult.xml +++ b/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> |