Skip to content

Commit c921b2a

Browse files
committed
Update consumer_timeout_ms docstring per #749
1 parent 77971ac commit c921b2a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

kafka/consumer/group.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ class KafkaConsumer(six.Iterator):
120120
receive_buffer_bytes (int): The size of the TCP receive buffer
121121
(SO_RCVBUF) to use when reading data. Default: None (relies on
122122
system defaults). The java client defaults to 32768.
123-
consumer_timeout_ms (int): number of millisecond to throw a timeout
124-
exception to the consumer if no message is available for
125-
consumption. Default: -1 (dont throw exception)
123+
consumer_timeout_ms (int): number of milliseconds to block during
124+
message iteration before raising StopIteration (i.e., ending the
125+
iterator). Default -1 (block forever).
126126
security_protocol (str): Protocol used to communicate with brokers.
127127
Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
128128
ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping

0 commit comments

Comments
 (0)