From e0020447616d79ed674f3338339b7557abc41b02 Mon Sep 17 00:00:00 2001
From: Ryan Roden-Corrent <ryan@rcorre.net>
Date: Sun, 22 Dec 2019 14:38:10 -0500
Subject: Be more specific about array return values.

The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
---
 doc/classes/Array.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index e09c1f4b08..2d330fc935 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -93,7 +93,7 @@
 			<return type="Variant">
 			</return>
 			<description>
-				Returns the last element of the array if the array is not empty.
+				Returns the last element of the array, or [code]null[/code] if the array is empty.
 			</description>
 		</method>
 		<method name="bsearch">
@@ -186,7 +186,7 @@
 			<return type="Variant">
 			</return>
 			<description>
-				Returns the first element of the array if the array is not empty.
+				Returns the first element of the array, or [code]null[/code] if the array is empty.
 			</description>
 		</method>
 		<method name="has">
@@ -243,14 +243,14 @@
 			<return type="Variant">
 			</return>
 			<description>
-				Removes the last element of the array.
+				Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty.
 			</description>
 		</method>
 		<method name="pop_front">
 			<return type="Variant">
 			</return>
 			<description>
-				Removes the first element of the array.
+				Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty.
 			</description>
 		</method>
 		<method name="push_back">
-- 
cgit v1.2.3