doc

docker/controller.py

@@ -295,11 +295,18 @@ class Manager:
             return (yield from asyncio.get_event_loop().run_in_executor(self._executor, *k))
 
 
-    # notes:
-    # - does not need to be reentrant
-    # - will be called a second time in a row if .process() is called during
-    #   the execution of ._process()
     def _process(self, key, reset):
+        """Actual implementation of the job (to be reimplemented in inherited classes)
+
+        The Manager class guarantees that this function cannot be called
+        multiple times concurrently on the same key (in case the same key is
+        submitted multiple times, they Manager will call this function a second
+        time after it has terminated).
+
+        `reset` is a function that may be called to reset the 'dirty' state of
+        this key (this is to avoid calling ._process() a second time if not
+        necessary)
+        """
         raise NotImplementedError()
 
     @asyncio.coroutine