From a2fe814857aae48d89c62b358b60807d1f966da8 Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Tue, 22 Feb 2022 15:20:33 -0500 Subject: [PATCH] Better doc string --- piker/data/_ahab.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/piker/data/_ahab.py b/piker/data/_ahab.py index 59bb4d55..651013f4 100644 --- a/piker/data/_ahab.py +++ b/piker/data/_ahab.py @@ -298,7 +298,16 @@ async def start_ahab( task_status: TaskStatus[trio.Event] = trio.TASK_STATUS_IGNORED, ) -> None: + ''' + Start a ``docker`` container supervisor with given service name. + Currently the actor calling this task should normally be started + with root permissions (until we decide to use something that doesn't + require this, like docker's rootless mode or some wrapper project) but + te root perms are de-escalated after the docker supervisor sub-actor + is started. + + ''' cn_ready = trio.Event() async with tractor.open_nursery( loglevel='runtime',