summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-03-09 11:35:28 +0100
committerGitHub <noreply@github.com>2020-03-09 11:35:28 +0100
commit4787da0997a38e16dd0aaacc6adc5d13092fc079 (patch)
tree127a13b49be3c1ded0b83f20daac687c5ec3fd11 /doc/classes
parentee543253ec6ee09d4bfcf0261e3d804368cd8a94 (diff)
parent788765709dfa5e0185cbecffad637dbb545a89aa (diff)
Merge pull request #36934 from akien-mga/variant-defargs
DocData: Fix serialization of Variant default values
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Array.xml8
-rw-r--r--doc/classes/Basis.xml2
-rw-r--r--doc/classes/Color.xml4
-rw-r--r--doc/classes/Dictionary.xml4
-rw-r--r--doc/classes/Plane.xml2
-rw-r--r--doc/classes/Rect2.xml2
-rw-r--r--doc/classes/Signal.xml2
-rw-r--r--doc/classes/String.xml14
8 files changed, 19 insertions, 19 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index 234949277a..6401feb95c 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -127,7 +127,7 @@
</return>
<argument index="0" name="value" type="Variant">
</argument>
- <argument index="1" name="before" type="bool" default="True">
+ <argument index="1" name="before" type="bool" default="true">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array.
@@ -143,7 +143,7 @@
</argument>
<argument index="2" name="func" type="String">
</argument>
- <argument index="3" name="before" type="bool" default="True">
+ <argument index="3" name="before" type="bool" default="true">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise.
@@ -169,7 +169,7 @@
<method name="duplicate">
<return type="Array">
</return>
- <argument index="0" name="deep" type="bool" default="False">
+ <argument index="0" name="deep" type="bool" default="false">
</argument>
<description>
Returns a copy of the array.
@@ -357,7 +357,7 @@
</argument>
<argument index="2" name="step" type="int" default="1">
</argument>
- <argument index="3" name="deep" type="bool" default="False">
+ <argument index="3" name="deep" type="bool" default="false">
</argument>
<description>
Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing.
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index e2b5c23c11..3952ea2d27 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -100,7 +100,7 @@
</return>
<argument index="0" name="b" type="Basis">
</argument>
- <argument index="1" name="epsilon" type="float" default="0.00001">
+ <argument index="1" name="epsilon" type="float" default="1e-05">
</argument>
<description>
Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml
index 7335ff5a2e..8587acade3 100644
--- a/doc/classes/Color.xml
+++ b/doc/classes/Color.xml
@@ -119,7 +119,7 @@
</argument>
<argument index="2" name="v" type="float">
</argument>
- <argument index="3" name="a" type="float" default="1">
+ <argument index="3" name="a" type="float" default="1.0">
</argument>
<description>
Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1.
@@ -224,7 +224,7 @@
<method name="to_html">
<return type="String">
</return>
- <argument index="0" name="with_alpha" type="bool" default="True">
+ <argument index="0" name="with_alpha" type="bool" default="true">
</argument>
<description>
Returns the color's HTML hexadecimal color string in ARGB format (ex: [code]ff34f822[/code]).
diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml
index 6104cf165e..062e72388f 100644
--- a/doc/classes/Dictionary.xml
+++ b/doc/classes/Dictionary.xml
@@ -75,7 +75,7 @@
<method name="duplicate">
<return type="Dictionary">
</return>
- <argument index="0" name="deep" type="bool" default="False">
+ <argument index="0" name="deep" type="bool" default="false">
</argument>
<description>
Creates a copy of the dictionary, and returns it.
@@ -102,7 +102,7 @@
</return>
<argument index="0" name="key" type="Variant">
</argument>
- <argument index="1" name="default" type="Variant" default="Null">
+ <argument index="1" name="default" type="Variant" default="null">
</argument>
<description>
Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted.
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml
index 8f0043fb86..292acd8b5d 100644
--- a/doc/classes/Plane.xml
+++ b/doc/classes/Plane.xml
@@ -77,7 +77,7 @@
</return>
<argument index="0" name="point" type="Vector3">
</argument>
- <argument index="1" name="epsilon" type="float" default="0.00001">
+ <argument index="1" name="epsilon" type="float" default="1e-05">
</argument>
<description>
Returns [code]true[/code] if [code]point[/code] is inside the plane (by a very minimum [code]epsilon[/code] threshold).
diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml
index 5bc55c9ce3..dbf461cdf1 100644
--- a/doc/classes/Rect2.xml
+++ b/doc/classes/Rect2.xml
@@ -143,7 +143,7 @@
</return>
<argument index="0" name="b" type="Rect2">
</argument>
- <argument index="1" name="include_borders" type="bool" default="False">
+ <argument index="1" name="include_borders" type="bool" default="false">
</argument>
<description>
Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common).
diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml
index ff428b887d..350ab40c0e 100644
--- a/doc/classes/Signal.xml
+++ b/doc/classes/Signal.xml
@@ -22,7 +22,7 @@
</return>
<argument index="0" name="callable" type="Callable">
</argument>
- <argument index="1" name="binds" type="Array" default="[]">
+ <argument index="1" name="binds" type="Array" default="[ ]">
</argument>
<argument index="2" name="flags" type="int" default="0">
</argument>
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index 1a5182b76e..a72b8f05d8 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -440,7 +440,7 @@
</return>
<argument index="0" name="values" type="Variant">
</argument>
- <argument index="1" name="placeholder" type="String" default="{_}">
+ <argument index="1" name="placeholder" type="String" default="&quot;{_}&quot;">
</argument>
<description>
Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code].
@@ -586,7 +586,7 @@
<method name="is_valid_hex_number">
<return type="bool">
</return>
- <argument index="0" name="with_prefix" type="bool" default="False">
+ <argument index="0" name="with_prefix" type="bool" default="false">
</argument>
<description>
Returns [code]true[/code] if this string contains a valid hexadecimal number. If [code]with_prefix[/code] is [code]true[/code], then a validity of the hexadecimal number is determined by [code]0x[/code] prefix, for instance: [code]0xDEADC0DE[/code].
@@ -810,7 +810,7 @@
</return>
<argument index="0" name="delimiter" type="String">
</argument>
- <argument index="1" name="allow_empty" type="bool" default="True">
+ <argument index="1" name="allow_empty" type="bool" default="true">
</argument>
<argument index="2" name="maxsplit" type="int" default="0">
</argument>
@@ -879,7 +879,7 @@
</return>
<argument index="0" name="delimiter" type="String">
</argument>
- <argument index="1" name="allow_empty" type="bool" default="True">
+ <argument index="1" name="allow_empty" type="bool" default="true">
</argument>
<argument index="2" name="maxsplit" type="int" default="0">
</argument>
@@ -901,7 +901,7 @@
</return>
<argument index="0" name="delimiter" type="String">
</argument>
- <argument index="1" name="allow_empty" type="bool" default="True">
+ <argument index="1" name="allow_empty" type="bool" default="true">
</argument>
<description>
Splits the string in floats by using a delimiter string and returns an array of the substrings.
@@ -911,9 +911,9 @@
<method name="strip_edges">
<return type="String">
</return>
- <argument index="0" name="left" type="bool" default="True">
+ <argument index="0" name="left" type="bool" default="true">
</argument>
- <argument index="1" name="right" type="bool" default="True">
+ <argument index="1" name="right" type="bool" default="true">
</argument>
<description>
Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.