diff options
| author | Isaac Clerencia <isaac.clerencia@gmail.com> | 2023-03-05 18:17:31 -0500 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-03-13 14:41:26 +0100 |
| commit | acdb1bdbd7aed6442e840074b3a5c09202be6660 (patch) | |
| tree | bb5b2555ddac78707cabc9268414e7bbbb3ee7f4 /modules | |
| parent | 9e6f0ee9c794a78557d49a2b7cdb43d4ac045c6d (diff) | |
Clarify Thread documentation
The current documentation uses the term "running" for two different things.
In the description of get_id() it claims "it will return empty string if the thread is not running", but it actually will return the thread id until wait_to_finish is called.
In the description of is_alive() it claims "it will return true if the thread is running", but in this case it means "the provided function hasn't finished running yet".
Updated the functions documentation slighly to make this clear.
(cherry picked from commit 2a4f38d54fbe8f6a35f5704fa9268e7f2d60b222)
Diffstat (limited to 'modules')
0 files changed, 0 insertions, 0 deletions