doc: mention return value for group.run() methods (#566)

Bogdanp · Aug 20, 2023 · d935fe4 · d935fe4
1 parent 76578a6
commit d935fe4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/dramatiq/composition.py b/dramatiq/composition.py
@@ -251,6 +251,9 @@ def run(self, *, delay=None):
         Parameters:
           delay(int): The minimum amount of time, in milliseconds,
             each message in the group should be delayed by.
+
+        Returns:
+          group: This same group.
         """
         if self.completion_callbacks:
             from .middleware.group_callbacks import GROUP_CALLBACK_BARRIER_TTL, GroupCallbacks