Removed incorrect infinite timeout value from request timeout doc in Admin APIs (confluentinc#1554)

pranavrth · web-flow · commit eab75fe76a05 · 2023-04-21T03:05:53.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,12 @@
 
 v2.1.1 is a maintenance release with the following fixes and enhancements:
 
+
 ### Fixes
 
 - Added a new ConsumerGroupState UNKNOWN. The typo state UNKOWN is deprecated and will be removed in the next major version.
+- Fix some Admin API documentation stating -1 for infinite timeout incorrectly.
+  Request timeout can't be infinite.
 
 
 ## v2.1.0
diff --git a/src/confluent_kafka/admin/__init__.py b/src/confluent_kafka/admin/__init__.py
@@ -629,8 +629,9 @@ def list_consumer_groups(self, **kwargs):
         """
         List consumer groups.
 
-        :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
-                  Default: `socket.timeout.ms*1000.0`
+        :param float request_timeout: The overall request timeout in seconds,
+                  including broker lookup, request transmission, operation time
+                  on broker, and response. Default: `socket.timeout.ms*1000.0`
         :param set(ConsumerGroupState) states: only list consumer groups which are currently in
                   these states.
 
@@ -664,8 +665,9 @@ def describe_consumer_groups(self, group_ids, **kwargs):
         Describe consumer groups.
 
         :param list(str) group_ids: List of group_ids which need to be described.
-        :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
-                  Default: `socket.timeout.ms*1000.0`
+        :param float request_timeout: The overall request timeout in seconds,
+                  including broker lookup, request transmission, operation time
+                  on broker, and response. Default: `socket.timeout.ms*1000.0`
 
         :returns: A dict of futures for each group, keyed by the group_id.
                   The future result() method returns :class:`ConsumerGroupDescription`.
@@ -695,8 +697,9 @@ def delete_consumer_groups(self, group_ids, **kwargs):
         Delete the given consumer groups.
 
         :param list(str) group_ids: List of group_ids which need to be deleted.
-        :param float request_timeout: Maximum response time before timing out, or -1 for infinite timeout.
-                  Default: `socket.timeout.ms*1000.0`
+        :param float request_timeout: The overall request timeout in seconds,
+                  including broker lookup, request transmission, operation time
+                  on broker, and response. Default: `socket.timeout.ms*1000.0`
 
         :returns: A dict of futures for each group, keyed by the group_id.
                   The future result() method returns None.
