From b2404578d203baecd41eb7b286e8cec10e037a0d Mon Sep 17 00:00:00 2001 From: Dana Powers Date: Mon, 15 Feb 2016 14:23:38 -0800 Subject: KAFKA-3044: Re-word consumer.poll behaviour --- kafka/consumer/group.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py index efd3bcc..4174b07 100644 --- a/kafka/consumer/group.py +++ b/kafka/consumer/group.py @@ -393,9 +393,10 @@ class KafkaConsumer(six.Iterator): Incompatible with iterator interface -- use one or the other, not both. Arguments: - timeout_ms (int, optional): milliseconds to spend waiting in poll if - data is not available. If 0, returns immediately with any - records that are available now. Must not be negative. Default: 0 + timeout_ms (int, optional): milliseconds spent waiting in poll if + data is not available in the buffer. If 0, returns immediately + with any records that are available currently in the buffer, + else returns empty. Must not be negative. Default: 0 Returns: dict: topic to list of records since the last fetch for the -- cgit v1.2.1