summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2018-07-17 11:47:27 +0200
committerRémi Verschelde <rverschelde@gmail.com>2018-07-17 11:47:27 +0200
commitadb16be6b96602061fcc2037e6b6e1e27ae41023 (patch)
tree86c6f0b8e756b9c69c329a3ba37d96232dfd2c7d
parent4565fd12160367ba930c56e4500d4fdb5b8c834b (diff)
Doc: Add example for array indexing
Supersedes and closes #20180.
-rw-r--r--doc/classes/Array.xml11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index 35c120cd6a..7fcb827252 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -4,7 +4,16 @@
Generic array datatype.
</brief_description>
<description>
- Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference.
+ Generic array, contains several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). Example:
+ [codeblock]
+ var array = ["One", 2, 3, "Four"]
+ print(array[0]) # One
+ print(array[2]) # 3
+ print(array[-1]) # Four
+ array[2] = "Three"
+ print(array[-2]) # Three
+ [/codeblock]
+ Arrays are always passed by reference.
</description>
<tutorials>
</tutorials>