docs: add docstring for BaseRunner.run method

ApeWorX · Sep 18, 2023 · 7bfccb2 · 7bfccb2
1 parent 9ab5f63
commit 7bfccb2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/silverback/runner.py b/silverback/runner.py
@@ -46,6 +46,15 @@ async def _event_task(
         """
 
     async def run(self):
+        """
+        Run the task broker client for the assembled `SilverbackApp` application.
+
+        Will listen for events against the connected provider (using `ManagerAccessMixin` context),
+        and process them by kicking events over to the configured broker.
+
+        Raises:
+            SilverbackException: If there are no configured tasks to execute.
+        """
         await self.app.broker.startup()
 
         if block_handler := self.app.get_block_handler():