diff --git a/coolamqp/clustering/cluster.py b/coolamqp/clustering/cluster.py index 29f105ca441451921d378cd6bcf9a504244be37b..8372e88fb3d21aff747574ee33174956cb42684b 100644 --- a/coolamqp/clustering/cluster.py +++ b/coolamqp/clustering/cluster.py @@ -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 """ diff --git a/docs/requirements.txt b/docs/requirements.txt index b1a5c58e5211ed17f21fdcf439e9ea87e5a55937..9543c34a8a2d84de696accdd804d3b669e57b86e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ six monotonic futures typing +typed_ast