Mark multiprocessing support as provisional (#387)

enthought · Jul 8, 2021 · 76b2814 · 76b2814
1 parent f0d1c3f
commit 76b2814
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/source/changes.rst b/docs/source/changes.rst
@@ -15,6 +15,15 @@ Release 0.3.0
 
 Release date: XXXX-XX-XX
 
+Features
+~~~~~~~~
+
+* Multiprocessing support: the :class:`~.TraitsExecutor` can now submit
+  background tasks to a process pool instead of a thread pool. Note: since this
+  support has not yet been tested in the wild, this support is provisional -
+  the API and the capabilities may change in a future release. Feedback is
+  welcome!
+
 Backwards-incompatible changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/source/guide/contexts.rst b/docs/source/guide/contexts.rst
@@ -12,6 +12,11 @@
 Contexts and multiprocessing
 ============================
 
+.. note::
+   The multiprocessing support in Traits Futures is provisional. The API
+   is subject to change in future releases. Feedback on the feature is
+   welcome.
+
 By default, the |TraitsExecutor| submits its background tasks to a thread pool.
 In some cases, for example in the case of multiple heavily CPU-bound background
 tasks, it may be desirable to run the background tasks in separate processes