Additional docstrings for autocommit close option

1 files changed, 7 insertions, 1 deletions

diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index 7d451b3..97df7a7 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -377,7 +377,13 @@ class KafkaConsumer(six.Iterator):
         return self._subscription.assigned_partitions()
 
     def close(self, autocommit=True):
-        """Close the consumer, waiting indefinitely for any needed cleanup."""
+        """Close the consumer, waiting indefinitely for any needed cleanup.
+
+        Keyword Arguments:
+            autocommit (bool): If auto-commit is configured for this consumer,
+                this optional flag causes the consumer to attempt to commit any
+                pending consumed offsets prior to close. Default: True
+        """
         if self._closed:
             return
         log.debug("Closing the KafkaConsumer.")