Skip to content

Commit

Permalink
docs: add missing docstring for Broker.join() function (Bogdanp#579)
Browse files Browse the repository at this point in the history
 # Reviewed, transaction id: 719
  • Loading branch information
jenstroeger authored and JetDrag committed Dec 16, 2023
1 parent 1d90281 commit 4466552
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion dramatiq/broker.py
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,16 @@ def flush_all(self): # pragma: no cover
raise NotImplementedError()

def join(self, queue_name, *, timeout=None): # pragma: no cover
"""
"""Wait for all the messages on the given queue to be
processed. This method is only meant to be used in tests to
wait for all the messages in a queue to be processed.
Subclasses that implement this function may add parameters.
Parameters:
queue_name(str): The queue to wait on.
timeout(Optional[int]): The max amount of time, in
milliseconds, to wait on this queue.
"""
raise NotImplementedError()

Expand Down

0 comments on commit 4466552

Please sign in to comment.