Remove 'event-like' as a type (#405)

* Remove 'event-like' as a type * Use class references
enthought · Jul 12, 2021 · 8a03b40 · 8a03b40
1 parent 048be2e
commit 8a03b40
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/traits_futures/i_parallel_context.py b/traits_futures/i_parallel_context.py
@@ -50,10 +50,10 @@ def event(self):
 
         Returns
         -------
-        event : event-like
+        event : object
             An event that can be shared safely with workers.
-            The event should have the same API as ``threading.Event``
-            and ``multiprocessing.Event``, providing at a minimum
+            The event should have the same API as :class:`threading.Event`
+            and :class:`multiprocessing.Event`, providing at a minimum
             the ``set`` and ``is_set`` methods from that API.
         """
 

diff --git a/traits_futures/multiprocessing_context.py b/traits_futures/multiprocessing_context.py
@@ -50,8 +50,11 @@ def event(self):
 
         Returns
         -------
-        event : event-like
+        event : object
             An event that can be shared safely with workers.
+            The event should have the same API as :class:`threading.Event`
+            and :class:`multiprocessing.Event`, providing at a minimum
+            the ``set`` and ``is_set`` methods from that API.
         """
         return self._manager.Event()
 

diff --git a/traits_futures/multithreading_context.py b/traits_futures/multithreading_context.py
@@ -49,8 +49,11 @@ def event(self):
 
         Returns
         -------
-        event : event-like
+        event : object
             An event that can be shared safely with workers.
+            The event should have the same API as :class:`threading.Event`
+            and :class:`multiprocessing.Event`, providing at a minimum
+            the ``set`` and ``is_set`` methods from that API.
         """
         return threading.Event()