Document KafkaAdmin class

dpkp · Oct 29, 2018 · cdfbb95 · cdfbb95
1 parent f00016e
commit cdfbb95
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/apidoc/KafkaAdmin.rst b/docs/apidoc/KafkaAdmin.rst
@@ -0,0 +1,5 @@
+KafkaAdmin
+===========
+
+.. autoclass:: kafka.admin.KafkaAdmin
+    :members:
diff --git a/kafka/admin/kafka.py b/kafka/admin/kafka.py
@@ -18,6 +18,13 @@
 class KafkaAdmin(object):
     """An class for administering the kafka cluster.
 
+    Warning:
+        This is an unstable interface that was recently added and is subject to
+        change without warning. In particular, many methods currently return
+        raw protocol tuples. In future releases, we plan to make these into
+        nicer, more pythonic objects. Unfortunately, this will likely break
+        those interfaces.
+
     The KafkaAdmin class will negotiate for the latest version of each message protocol format supported
     by both the kafka-python client library and the kafka broker.  Usage of optional fields from protocol
     versions that are not supported by the broker will result in UnsupportedVersionError exceptions.