summaryrefslogtreecommitdiff
path: root/kafka/producer/kafka.py
diff options
context:
space:
mode:
Diffstat (limited to 'kafka/producer/kafka.py')
-rw-r--r--kafka/producer/kafka.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/kafka/producer/kafka.py b/kafka/producer/kafka.py
index 3abadcc..57155e5 100644
--- a/kafka/producer/kafka.py
+++ b/kafka/producer/kafka.py
@@ -554,6 +554,10 @@ class KafkaProducer(object):
Arguments:
timeout (float, optional): timeout in seconds to wait for completion.
+
+ Raises:
+ KafkaTimeoutError: failure to flush buffered records within the
+ provided timeout
"""
log.debug("Flushing accumulated records in producer.") # trace
self._accumulator.begin_flush()