From 660a780c3b4431fb253d8fb7dcfa388c90ed6b2b Mon Sep 17 00:00:00 2001
From: Bob Gardner <bob@etanine.com>
Date: Wed, 8 Jul 2020 09:51:51 -0700
Subject: Update Resource.xml to explain behavior of duplicate when
 subresources is true and a subresource contains further nested resources.

Updated documentation for duplicate() on Resource to better explain the behavior. As per #30385.
---
 doc/classes/Resource.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml
index 5bc34772c8..0aa40dffb3 100644
--- a/doc/classes/Resource.xml
+++ b/doc/classes/Resource.xml
@@ -23,7 +23,8 @@
 			<argument index="0" name="subresources" type="bool" default="false">
 			</argument>
 			<description>
-				Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency, this can be changed by passing [code]true[/code] to the [code]subresources[/code] argument.
+				Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
+				[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
 			</description>
 		</method>
 		<method name="get_local_scene" qualifiers="const">
-- 
cgit v1.2.3