Merge pull request #46656 from zaksnet/improve-thread-docs

Improve documentation for Thread
2021-09-09 14:10:35 +02:00 · 2021-09-09 14:10:35 +02:00 · 7b846e3f01
parent 43a9a9f680 9e2882a989
commit 7b846e3f01
1 changed files with 2 additions and 0 deletions
--- a/doc/classes/Thread.xml
+++ b/doc/classes/Thread.xml
@ -40,6 +40,8 @@
 			<return type="Variant" />
 			<description>
 				Joins the [Thread] and waits for it to finish. Returns what the method called returned.
+				Should either be used when you want to retrieve the value returned from the method called by the [Thread] or before freeing the instance that contains the [Thread].
+				[b]Note:[/b] After the [Thread] finishes joining it will be disposed. If you want to use it again you will have to create a new instance of it.
 			</description>
 		</method>
 	</methods>