diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2016-12-19 11:26:46 -0800 |
|---|---|---|
| committer | Dana Powers <dana.powers@gmail.com> | 2016-12-19 11:26:46 -0800 |
| commit | f6291e655d556ed7e0eecdad456f4e28b01b8d2b (patch) | |
| tree | 4810743027ed0f17cf47d7666489786bfe268793 | |
| parent | 46f9b1f681e8e999fbe6a1704c65cc35dca38f4c (diff) | |
| download | kafka-python-f6291e655d556ed7e0eecdad456f4e28b01b8d2b.tar.gz | |
Add docstring for max_records (#897)
| -rw-r--r-- | kafka/consumer/group.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py index 02915b4..9ebf604 100644 --- a/kafka/consumer/group.py +++ b/kafka/consumer/group.py @@ -503,6 +503,9 @@ class KafkaConsumer(six.Iterator): 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 + max_records (int, optional): The maximum number of records returned + in a single call to :meth:`poll`. Default: Inherit value from + max_poll_records. Returns: dict: topic to list of records since the last fetch for the |