From 9e2882a98982e4d0a8550feca468b87120515bd2 Mon Sep 17 00:00:00 2001 From: Zak Date: Thu, 4 Mar 2021 15:27:14 +0100 Subject: [PATCH] Improve docs for Thread An attempt to improve the documentation for Thread - Adds documentation on how and when the `wait_to_finish` should be used - Adds a note on what to be careful about when using `wait_to_finish` --- doc/classes/Thread.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 88f46e3937b..9c3aaca4035 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -48,6 +48,8 @@ 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.