summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAsk Solem <ask@celeryproject.org>2012-11-27 15:48:42 +0000
committerAsk Solem <ask@celeryproject.org>2012-11-27 15:48:42 +0000
commitf68f8ac8c0808c6c33f3c4cbab7c7932e1ccd48d (patch)
treea4ec01bc6f13bb11ece248c5384103c76f3bc22b /docs/userguide
parent325fcc0522571096b424080c232f0d87a1e5865e (diff)
parent6b77885cf0e26b0f08a38db08835e8e43cd3ae91 (diff)
downloadkombu-f68f8ac8c0808c6c33f3c4cbab7c7932e1ccd48d.tar.gz
Merge branch 'master' into 3.0
Conflicts: kombu/abstract.py kombu/clocks.py kombu/messaging.py kombu/pidbox.py kombu/pools.py kombu/tests/mocks.py kombu/tests/test_common.py kombu/tests/test_messaging.py kombu/tests/test_serialization.py kombu/tests/test_utils.py kombu/tests/transport/test_redis.py kombu/tests/utilities/test_encoding.py kombu/transport/pika.py kombu/transport/zmq.py kombu/transport/zookeeper.py kombu/utils/__init__.py kombu/utils/encoding.py kombu/utils/finalize.py pavement.py requirements/default.txt
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/connections.rst7
-rw-r--r--docs/userguide/consumers.rst7
-rw-r--r--docs/userguide/producers.rst5
-rw-r--r--docs/userguide/serialization.rst28
-rw-r--r--docs/userguide/simple.rst2
5 files changed, 19 insertions, 30 deletions
diff --git a/docs/userguide/connections.rst b/docs/userguide/connections.rst
index d7275ea4..aa88add8 100644
--- a/docs/userguide/connections.rst
+++ b/docs/userguide/connections.rst
@@ -116,10 +116,7 @@ keyword arguments, these are:
:ssl: Use SSL to connect to the server. Default is ``False``.
Only supported by the amqp transport.
:insist: Insist on connecting to a server.
- In a configuration with multiple load-sharing servers, the insist
- option tells the server that the client is insisting on a connection
- to the specified server. Default is ``False``.
- Only supported by the amqp and pika transports, and not by AMQP 0-9-1.
+ *No longer supported, relic from AMQP 0.8*
:connect_timeout: Timeout in seconds for connecting to the
server. May not be supported by the specified transport.
:transport_options: A dict of additional connection arguments to
@@ -142,8 +139,6 @@ Transport Comparison
+---------------+----------+------------+------------+---------------+
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ |
+---------------+----------+------------+------------+---------------+
-| *pika* | Native | Yes | Yes | Yes |
-+---------------+----------+------------+------------+---------------+
| *couchdb* | Virtual | Yes | Yes [#f1]_ | No |
+---------------+----------+------------+------------+---------------+
| *zookeeper* | Virtual | Yes | Yes [#f1]_ | No |
diff --git a/docs/userguide/consumers.rst b/docs/userguide/consumers.rst
index 74ab79cf..5e9d3d61 100644
--- a/docs/userguide/consumers.rst
+++ b/docs/userguide/consumers.rst
@@ -1,4 +1,3 @@
-.. currentmodule:: kombu.messaging
.. _guide-consumers:
===========
@@ -62,7 +61,7 @@ and with multiple channels again:
.. code-block:: python
- from kombu.messaging import Consumer
+ from kombu import Consumer
from kombu.mixins import ConsumerMixin
class C(ConsumerMixin):
@@ -88,8 +87,6 @@ and with multiple channels again:
Reference
=========
-.. module:: kombu.messaging
-
-.. autoclass:: Consumer
+.. autoclass:: kombu.Consumer
:noindex:
:members:
diff --git a/docs/userguide/producers.rst b/docs/userguide/producers.rst
index c6e80625..454b4ca3 100644
--- a/docs/userguide/producers.rst
+++ b/docs/userguide/producers.rst
@@ -1,4 +1,3 @@
-.. currentmodule:: kombu.messaging
.. _guide-producers:
===========
@@ -20,8 +19,6 @@ See :ref:`guide-serialization`.
Reference
=========
-.. module:: kombu.messaging
-
-.. autoclass:: Producer
+.. autoclass:: kombu.Producer
:noindex:
:members:
diff --git a/docs/userguide/serialization.rst b/docs/userguide/serialization.rst
index b3648d14..3f236861 100644
--- a/docs/userguide/serialization.rst
+++ b/docs/userguide/serialization.rst
@@ -138,24 +138,24 @@ supported by Kombu.
.. admonition:: Buffer Objects
-The decoder function of custom serializer must support both strings
-and Python's old-style buffer objects.
+ The decoder function of custom serializer must support both strings
+ and Python's old-style buffer objects.
-Python pickle and json modules usually don't do this via its ``loads``
-function, but you can easily add support by making a wrapper around the
-``load`` function that takes file objects instead of strings.
+ Python pickle and json modules usually don't do this via its ``loads``
+ function, but you can easily add support by making a wrapper around the
+ ``load`` function that takes file objects instead of strings.
-Here's an example wrapping :func:`pickle.loads` in such a way:
+ Here's an example wrapping :func:`pickle.loads` in such a way:
-.. code-block:: python
+ .. code-block:: python
- import pickle
- from kombu.serialization import BytesIO, register
+ import pickle
+ from kombu.serialization import BytesIO, register
- def loads(s):
- return pickle.load(BytesIO(s))
+ def loads(s):
+ return pickle.load(BytesIO(s))
- register('my_pickle', loads, pickle.dumps,
- content_type='application/x-pickle2',
- content_encoding='binary')
+ register('my_pickle', loads, pickle.dumps,
+ content_type='application/x-pickle2',
+ content_encoding='binary')
diff --git a/docs/userguide/simple.rst b/docs/userguide/simple.rst
index 9239f118..69caaf2d 100644
--- a/docs/userguide/simple.rst
+++ b/docs/userguide/simple.rst
@@ -16,7 +16,7 @@ messaging needs.
Instead of defining exchanges and queues, the simple classes only requires
two arguments, a connection channel and a name. The name is used as the
queue, exchange and routing key. If the need arises, you can specify
-a :class:`~kombu.entity.Queue` as the name argument instead.
+a :class:`~kombu.Queue` as the name argument instead.
In addition, the :class:`~kombu.Connection` comes with
shortcuts to create simple queues using the current connection::