From 9b9551c37dec21eebc44912795a078da07320d24 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Fri, 3 Jan 2020 16:47:19 +0100
Subject: [PATCH] fix pydoc for cluster
---
coolamqp/clustering/cluster.py | 3 +++
docs/requirements.txt | 1 +
2 files changed, 4 insertions(+)
diff --git a/coolamqp/clustering/cluster.py b/coolamqp/clustering/cluster.py
index 29f105c..8372e88 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 b1a5c58..9543c34 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -3,3 +3,4 @@ six
monotonic
futures
typing
+typed_ast
--
GitLab