Document the in operator in String, Array and Dictionary classes

This also clarifies the `in` operator behavior in Object.

(cherry picked from commit 7f01f68226)
This commit is contained in:
Hugo Locurcio
2020-06-11 19:53:55 +02:00
committed by Rémi Verschelde
parent 50c4834548
commit 5a1f94ba47
4 changed files with 26 additions and 6 deletions

View File

@@ -176,7 +176,7 @@
<argument index="1" name="from" type="int" default="0">
</argument>
<description>
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed.
</description>
</method>
<method name="find_last">
@@ -185,7 +185,7 @@
<argument index="0" name="value" type="Variant">
</argument>
<description>
Searches the array in reverse order for a value and returns its index or -1 if not found.
Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found.
</description>
</method>
<method name="front">
@@ -208,6 +208,12 @@
["inside", 7].has(7) == true
["inside", 7].has("7") == false
[/codeblock]
[b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows:
[codeblock]
# Will evaluate to `true`.
if 2 in [2, 4, 6, 8]:
pass
[/codeblock]
</description>
</method>
<method name="hash">