Skip to content

Commit f6291e6

Browse files
jeffwidmandpkp
authored andcommitted
Add docstring for max_records (#897)
1 parent 46f9b1f commit f6291e6

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

kafka/consumer/group.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,9 @@ def poll(self, timeout_ms=0, max_records=None):
503503
data is not available in the buffer. If 0, returns immediately
504504
with any records that are available currently in the buffer,
505505
else returns empty. Must not be negative. Default: 0
506+
max_records (int, optional): The maximum number of records returned
507+
in a single call to :meth:`poll`. Default: Inherit value from
508+
max_poll_records.
506509
507510
Returns:
508511
dict: topic to list of records since the last fetch for the

0 commit comments

Comments
 (0)