From 6b797574a2a238968211daa6c731bae56e7bff05 Mon Sep 17 00:00:00 2001
From: krogank9 <wifi.mouse.app@gmail.com>
Date: Sat, 21 Apr 2018 19:23:50 -0400
Subject: [PATCH] [DOCS] Add note that Pool*Arrays are passed by value (#18340)

---
 doc/classes/PoolByteArray.xml    | 2 +-
 doc/classes/PoolColorArray.xml   | 2 +-
 doc/classes/PoolIntArray.xml     | 2 +-
 doc/classes/PoolRealArray.xml    | 2 +-
 doc/classes/PoolStringArray.xml  | 2 +-
 doc/classes/PoolVector2Array.xml | 2 +-
 doc/classes/PoolVector3Array.xml | 2 +-
 7 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml
index 0118e7477a9..120d80ba392 100644
--- a/doc/classes/PoolByteArray.xml
+++ b/doc/classes/PoolByteArray.xml
@@ -4,7 +4,7 @@
 		Raw byte array.
 	</brief_description>
 	<description>
-		Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory.
+		Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml
index 0a4221728e7..0c93a565f5f 100644
--- a/doc/classes/PoolColorArray.xml
+++ b/doc/classes/PoolColorArray.xml
@@ -4,7 +4,7 @@
 		Array of Colors
 	</brief_description>
 	<description>
-		Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory.
+		Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml
index 7709a69c849..43cb5d77de1 100644
--- a/doc/classes/PoolIntArray.xml
+++ b/doc/classes/PoolIntArray.xml
@@ -4,7 +4,7 @@
 		Integer Array.
 	</brief_description>
 	<description>
-		Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory.
+		Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml
index 19f31f7dfbf..0808b441041 100644
--- a/doc/classes/PoolRealArray.xml
+++ b/doc/classes/PoolRealArray.xml
@@ -4,7 +4,7 @@
 		Real Array.
 	</brief_description>
 	<description>
-		Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory.
+		Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml
index 3d971d1ac97..9f6c4306cb9 100644
--- a/doc/classes/PoolStringArray.xml
+++ b/doc/classes/PoolStringArray.xml
@@ -4,7 +4,7 @@
 		String Array.
 	</brief_description>
 	<description>
-		String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory.
+		String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml
index 14c226d019b..072281158c3 100644
--- a/doc/classes/PoolVector2Array.xml
+++ b/doc/classes/PoolVector2Array.xml
@@ -4,7 +4,7 @@
 		An Array of Vector2.
 	</brief_description>
 	<description>
-		An Array specifically designed to hold Vector2.
+		An Array specifically designed to hold Vector2. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>
diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml
index 27ddfa10a53..7aa5dfc0909 100644
--- a/doc/classes/PoolVector3Array.xml
+++ b/doc/classes/PoolVector3Array.xml
@@ -4,7 +4,7 @@
 		An Array of Vector3.
 	</brief_description>
 	<description>
-		An Array specifically designed to hold Vector3.
+		An Array specifically designed to hold Vector3. Note that this type is passed by value and not by reference.
 	</description>
 	<tutorials>
 	</tutorials>