Skip to content
Snippets Groups Projects
Commit 9b9551c3 authored by Piotr Maślanka's avatar Piotr Maślanka
Browse files

fix pydoc for cluster

parent 745bf66e
No related branches found
No related tags found
No related merge requests found
......@@ -78,6 +78,7 @@ class Cluster(object):
# concurrent.futures.Future
"""
Declare a Queue/Exchange
:param obj: Queue/Exchange object
:param persistent: should it be redefined upon reconnect?
:return: Future
......@@ -87,6 +88,7 @@ class Cluster(object):
def drain(self, timeout): # type: (float) -> Event
"""
Return an Event.
:param timeout: time to wait for an event. 0 means return immediately. None means block forever
:return: an Event instance. NothingMuch is returned when there's nothing within a given timoeout
"""
......@@ -239,6 +241,7 @@ class Cluster(object):
def shutdown(self, wait=True): # type: (bool) -> None
"""
Terminate all connections, release resources - finish the job.
:param wait: block until this is done
:raise RuntimeError: if called without start() being called first
"""
......
......@@ -3,3 +3,4 @@ six
monotonic
futures
typing
typed_ast
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment