From 8758fffd919aa28c612c2b0703bb04c74d4b1d81 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Wed, 13 Nov 2024 14:38:58 +0100
Subject: [PATCH] argumentify added
---
coolamqp/clustering/cluster.py | 2 +-
docs/reference.rst | 13 ++++++-------
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/coolamqp/clustering/cluster.py b/coolamqp/clustering/cluster.py
index f1e7342..f81e364 100644
--- a/coolamqp/clustering/cluster.py
+++ b/coolamqp/clustering/cluster.py
@@ -187,7 +187,7 @@ class Cluster(object):
"""
Start consuming from a queue.
- args and kwargs will be passed to Consumer constructor (coolamqp.attaches.consumer.Consumer).
+ args and kwargs will be passed to Consumer constructor.
Don't use future_to_notify - it's done here!
Take care not to lose the Consumer object - it's the only way to cancel a consumer!
diff --git a/docs/reference.rst b/docs/reference.rst
index a5cf4ea..73ec242 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -8,14 +8,13 @@ Cluster-related things
:members:
.. note:: If environment variable :code:`COOLAMQP_FORCE_SELECT_LISTENER` is defined, select will be used instead of epoll.
-
+ This will automatically use select if epoll is not available (eg. Windows).
.. autoclass:: coolamqp.attaches.consumer.BodyReceiveMode
:members:
.. autoclass:: coolamqp.attaches.consumer.Consumer
:members:
- :undoc-members:
Please note that :meth:`coolamqp.clustering.Cluster.consume` passes lot of it's
args and kwargs directly to the :class:`coolamqp.attaches.consumer.Consumer`.
@@ -23,19 +22,19 @@ args and kwargs directly to the :class:`coolamqp.attaches.consumer.Consumer`.
Extra objects
-------------
-.. class:: coolamqp.objects.Message
+.. autoclass:: coolamqp.objects.Message
:members:
-.. class:: coolamqp.objects.ReceivedMessage
+.. autoclass:: coolamqp.objects.ReceivedMessage
:members:
-.. class:: coolamqp.objects.MessageProperties
+.. autoclass:: coolamqp.objects.MessageProperties
:members:
-.. class:: coolamqp.objects.Queue
+.. autoclass:: coolamqp.objects.Queue
:members:
-.. class:: coolamqp.objects.Exchange
+.. autoclass:: coolamqp.objects.Exchange
:members:
--
GitLab