From 263f620421773e74a0d5c0306c1453883dc205bb Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sun, 6 Sep 2020 15:20:42 +0200 Subject: [PATCH] Improve documentation related to Array error handling This closes https://github.com/godotengine/godot-docs/issues/3834. --- doc/classes/Array.xml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 61df5e092e1..20579e0159c 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -119,7 +119,8 @@ - Returns the last element of the array. Throws an error and returns [code]null[/code] if the array is empty. + Returns the last element of the array. Prints an error and returns [code]null[/code] if the array is empty. + [b]Note:[/b] Calling this function is not the same as writing [code]array[-1][/code]. If the array is empty, accessing by index will pause project execution when running from the editor. @@ -216,7 +217,8 @@ - Returns the first element of the array. Throws an error and returns [code]null[/code] if the array is empty. + Returns the first element of the array. Prints an error and returns [code]null[/code] if the array is empty. + [b]Note:[/b] Calling this function is not the same as writing [code]array[0][/code]. If the array is empty, accessing by index will pause project execution when running from the editor. @@ -283,14 +285,14 @@ - Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty. + Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. - Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty. + Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty, wwithout printing an error message. @@ -317,7 +319,7 @@ - Removes an element from the array by index. + Removes an element from the array by index. If the index does not exist in the array, nothing happens.