breaking: Follow threading.Thread.join() function signature

Author: caffeine-addictt

src/thread/thread.py

@@ -230,18 +230,14 @@ def add_hook(self, hook: HookFunction[_Target_T]) -> None:
         """
         self.hooks.append(hook)
 
-    def join(self, timeout: Optional[float] = None) -> bool:
+    def join(self, timeout: Optional[float] = None) -> None:
         """
         Halts the current thread execution until a thread completes or exceeds the timeout
 
         Parameters
         ----------
         :param timeout: The maximum time allowed to halt the thread
 
-        Returns
-        -------
-        :returns bool: True if the thread is no-longer alive
-
         Raises
         ------
         ThreadNotInitializedError: If the thread is not initialized
@@ -255,7 +251,6 @@ def join(self, timeout: Optional[float] = None) -> bool:
 
         super().join(timeout)
         self._handle_exceptions()
-        return not self.is_alive()
 
     def get_return_value(self) -> _Target_T:
         """
@@ -598,14 +593,10 @@ def get_return_values(self) -> List[_Dataset_T]:
             results += entry.thread.result
         return results
 
-    def join(self) -> bool:
+    def join(self) -> None:
         """
         Halts the current thread execution until a thread completes or exceeds the timeout
 
-        Returns
-        -------
-        :returns bool: True if the thread is no-longer alive
-
         Raises
         ------
         ThreadNotInitializedError: If the thread is not initialized
@@ -619,7 +610,6 @@ def join(self) -> bool:
 
         for entry in self._threads:
             entry.thread.join()
-        return True
 
     def kill(self) -> None:
         """

tests/test_thread.py

@@ -21,7 +21,8 @@ def test_threadCreation():
         target=_dummy_target_raiseToPower, args=[4], kwargs={'power': 2}, daemon=True
     )
     new.start()
-    assert new.join()
+    new.join()
+    assert not new.is_alive()
     assert new.result == 16