Skip to content

Commit b240457

Browse files
committed
KAFKA-3044: Re-word consumer.poll behaviour
1 parent c0d6273 commit b240457

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

kafka/consumer/group.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,9 +393,10 @@ def poll(self, timeout_ms=0):
393393
Incompatible with iterator interface -- use one or the other, not both.
394394
395395
Arguments:
396-
timeout_ms (int, optional): milliseconds to spend waiting in poll if
397-
data is not available. If 0, returns immediately with any
398-
records that are available now. Must not be negative. Default: 0
396+
timeout_ms (int, optional): milliseconds spent waiting in poll if
397+
data is not available in the buffer. If 0, returns immediately
398+
with any records that are available currently in the buffer,
399+
else returns empty. Must not be negative. Default: 0
399400
400401
Returns:
401402
dict: topic to list of records since the last fetch for the

0 commit comments

Comments
 (0)