From d3051b263748ad0fd55342a8a696fedefcac18b5 Mon Sep 17 00:00:00 2001
From: Brian Semrau <brian.semrau@gmail.com>
Date: Sun, 31 Oct 2021 23:06:57 -0400
Subject: GDScript gracefully handle debug functions from separate thread

---
 modules/gdscript/doc_classes/@GDScript.xml | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'modules/gdscript/doc_classes')

diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index 631ee4d895..5b476cda01 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -98,6 +98,7 @@
 				[codeblock]
 				[{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}]
 				[/codeblock]
+				[b]Note:[/b] Not supported for calling from threads. Instead, this will return an empty array.
 			</description>
 		</method>
 		<method name="inst2dict">
@@ -160,17 +161,24 @@
 		<method name="print_debug" qualifiers="vararg">
 			<return type="void" />
 			<description>
-				Like [method @GlobalScope.print], but prints only when used in debug mode.
+				Like [method @GlobalScope.print], but includes the current stack frame when running with the debugger turned on.
+				Output in the console would look something like this:
+				[codeblock]
+				Test print
+				   At: res://test.gd:15:_process()
+				[/codeblock]
+				[b]Note:[/b] Not supported for calling from threads. Instead of the stack frame, this will print the thread ID.
 			</description>
 		</method>
 		<method name="print_stack">
 			<return type="void" />
 			<description>
-				Prints a stack track at code location, only works when running with debugger turned on.
+				Prints a stack trace at the current code location. Only works when running with debugger turned on.
 				Output in the console would look something like this:
 				[codeblock]
 				Frame 0 - res://test.gd:16 in function '_process'
 				[/codeblock]
+				[b]Note:[/b] Not supported for calling from threads. Instead of the stack trace, this will print the thread ID.
 			</description>
 		</method>
 		<method name="range" qualifiers="vararg">
-- 
cgit v1.2.3