diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2017-03-03 10:14:54 -0800 |
|---|---|---|
| committer | Dana Powers <dana.powers@gmail.com> | 2017-03-03 10:14:54 -0800 |
| commit | d9283c14534dd56456e7a3f259f512fa57cc40ad (patch) | |
| tree | 451818e8d3795fb6ea1012db89d322b87bdf5509 /kafka/producer/base.py | |
| parent | b1f22b882a338a3456ca88782e05660cffff72f6 (diff) | |
| download | kafka-python-d9283c14534dd56456e7a3f259f512fa57cc40ad.tar.gz | |
Add sphinx formatting to hyperlink methods (#898)
Diffstat (limited to 'kafka/producer/base.py')
| -rw-r--r-- | kafka/producer/base.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/kafka/producer/base.py b/kafka/producer/base.py index 4079e22..8d067aa 100644 --- a/kafka/producer/base.py +++ b/kafka/producer/base.py @@ -56,7 +56,8 @@ def _send_upstream(queue, client, codec, batch_time, batch_size, Messages placed on the queue should be tuples that conform to this format: ((topic, partition), message, key) - Currently does not mark messages with task_done. Do not attempt to join()! + Currently does not mark messages with task_done. Do not attempt to + :meth:`join`! Arguments: queue (threading.Queue): the queue from which to get messages @@ -227,7 +228,8 @@ class Producer(object): Arguments: client (kafka.SimpleClient): instance to use for broker communications. If async=True, the background thread will use - client.copy(), which is expected to return a thread-safe object. + :meth:`client.copy`, which is expected to return a thread-safe + object. codec (kafka.protocol.ALL_CODECS): compression codec to use. req_acks (int, optional): A value indicating the acknowledgements that the server must receive before responding to the request, @@ -263,7 +265,7 @@ class Producer(object): will not allow you to identify the specific message that failed, but it will allow you to match failures with retries. async_stop_timeout (int or float, optional): seconds to continue - attempting to send queued messages after producer.stop(), + attempting to send queued messages after :meth:`producer.stop`, defaults to 30. Deprecated Arguments: |