Skip to content

Commit eab75fe

Browse files
authored
Removed incorrect infinite timeout value from request timeout doc in Admin APIs (#1554)
1 parent 30a08d4 commit eab75fe

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
@@ -629,8 +629,9 @@ def list_consumer_groups(self, **kwargs):
629629
"""
630630
List consumer groups.
631631
632-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
633-
Default: `socket.timeout.ms*1000.0`
632+
:param float request_timeout: The overall request timeout in seconds,
633+
including broker lookup, request transmission, operation time
634+
on broker, and response. Default: `socket.timeout.ms*1000.0`
634635
:param set(ConsumerGroupState) states: only list consumer groups which are currently in
635636
these states.
636637
@@ -664,8 +665,9 @@ def describe_consumer_groups(self, group_ids, **kwargs):
664665
Describe consumer groups.
665666
666667
:param list(str) group_ids: List of group_ids which need to be described.
667-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
668-
Default: `socket.timeout.ms*1000.0`
668+
:param float request_timeout: The overall request timeout in seconds,
669+
including broker lookup, request transmission, operation time
670+
on broker, and response. Default: `socket.timeout.ms*1000.0`
669671
670672
:returns: A dict of futures for each group, keyed by the group_id.
671673
The future result() method returns :class:`ConsumerGroupDescription`.
@@ -695,8 +697,9 @@ def delete_consumer_groups(self, group_ids, **kwargs):
695697
Delete the given consumer groups.
696698
697699
:param list(str) group_ids: List of group_ids which need to be deleted.
698-
:param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
699-
Default: `socket.timeout.ms*1000.0`
700+
:param float request_timeout: The overall request timeout in seconds,
701+
including broker lookup, request transmission, operation time
702+
on broker, and response. Default: `socket.timeout.ms*1000.0`
700703
701704
:returns: A dict of futures for each group, keyed by the group_id.
702705
The future result() method returns None.

0 commit comments

Comments
 (0)