add note about combination with parallelize

Author: falkoschindler

rosys/automation/automation.py

@@ -12,7 +12,10 @@
 
 
 def uninterruptible(func: Callable):
-    """Decorator to make an async function uninterruptible until it exits."""
+    """Decorator to make an async function uninterruptible until it exits.
+
+    Note that ``rosys.automation.parallelize`` will also be uninterruptible if one of its coroutines is marked with this decorator.
+    """
     @functools.wraps(func)
     async def _wrapped(*args, **kwargs):
         automation = _CURRENT_AUTOMATION.get()

rosys/automation/parallelize.py

@@ -8,6 +8,8 @@ class parallelize:
     This class allows to combine multiple coroutines into one that can be passed to the
     `automator <https://rosys.io/reference/rosys/automation/#rosys.automation.Automator>`__
     to run them in parallel.
+
+    Note that ``parallelize`` will be uninterruptible if one of its coroutines is marked with ``@rosys.automation.uninterruptible``.
     """
 
     def __init__(self, *coros: Coroutine, return_when_first_completed: bool = False) -> None: