worker: add note about correct use of close()

sbourdeauducq · sbourdeauducq · commit 78f926827722 · 2015-06-04T11:30:34.000+08:00
diff --git a/artiq/master/worker.py b/artiq/master/worker.py
@@ -75,6 +75,11 @@ def _create_process(self):
 
     @asyncio.coroutine
     def close(self):
+        """Interrupts any I/O with the worker process and terminates the
+        worker process.
+
+        This method should always be called by the user to clean up, even if
+        prepare() raises an exception."""
         self.closed.set()
         yield from self.io_lock.acquire()
         try:
