Document connections_max_idle_ms

This was added in #1068 but never documented.
Fix #1497

1 files changed, 5 insertions, 0 deletions

diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index 9abf15e..1c3ec63 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -212,6 +212,11 @@ class KafkaConsumer(six.Iterator):
         api_version_auto_timeout_ms (int): number of milliseconds to throw a
             timeout exception from the constructor when checking the broker
             api version. Only applies if api_version set to 'auto'
+        connections_max_idle_ms: Close idle connections after the number of
+            milliseconds specified by this config. The broker closes idle
+            connections after connections.max.idle.ms, so this avoids hitting
+            unexpected socket disconnected errors on the client.
+            Default: 540000
         metric_reporters (list): A list of classes to use as metrics reporters.
             Implementing the AbstractMetricsReporter interface allows plugging
             in classes that will be notified of new metric creation. Default: []