Skip to content

Commit a0efece

Browse files
pranavrthemasab
authored andcommitted
Removed incorrect infinite timeout value from request timeout doc in Admin APIs (#1554)
1 parent a1eedad commit a0efece

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
v2.1.1 is a maintenance release with the following fixes and enhancements:
66

7+
78
### Fixes
89

910
- Added a new ConsumerGroupState UNKNOWN. The typo state UNKOWN is deprecated and will be removed in the next major version.
11+
- Fix some Admin API documentation stating -1 for infinite timeout incorrectly.
12+
Request timeout can't be infinite.
1013

1114

1215
## v2.1.0

src/confluent_kafka/admin/__init__.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -659,8 +659,9 @@ def list_consumer_groups(self, **kwargs):
659659
"""
660660
List consumer groups.
661661
662-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
663-
Default: `socket.timeout.ms*1000.0`
662+
:param float request_timeout: The overall request timeout in seconds,
663+
including broker lookup, request transmission, operation time
664+
on broker, and response. Default: `socket.timeout.ms*1000.0`
664665
:param set(ConsumerGroupState) states: only list consumer groups which are currently in
665666
these states.
666667
@@ -694,8 +695,9 @@ def describe_consumer_groups(self, group_ids, **kwargs):
694695
Describe consumer groups.
695696
696697
:param list(str) group_ids: List of group_ids which need to be described.
697-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
698-
Default: `socket.timeout.ms*1000.0`
698+
:param float request_timeout: The overall request timeout in seconds,
699+
including broker lookup, request transmission, operation time
700+
on broker, and response. Default: `socket.timeout.ms*1000.0`
699701
700702
:returns: A dict of futures for each group, keyed by the group_id.
701703
The future result() method returns :class:`ConsumerGroupDescription`.
@@ -725,8 +727,9 @@ def delete_consumer_groups(self, group_ids, **kwargs):
725727
Delete the given consumer groups.
726728
727729
:param list(str) group_ids: List of group_ids which need to be deleted.
728-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
729-
Default: `socket.timeout.ms*1000.0`
730+
:param float request_timeout: The overall request timeout in seconds,
731+
including broker lookup, request transmission, operation time
732+
on broker, and response. Default: `socket.timeout.ms*1000.0`
730733
731734
:returns: A dict of futures for each group, keyed by the group_id.
732735
The future result() method returns None.

0 commit comments

Comments
 (0)