Added ThrottleEvent to docs

edenhill · edenhill · commit 1266b3cb12e4 · 2018-06-02T10:51:49.000+02:00
diff --git a/confluent_kafka/__init__.py b/confluent_kafka/__init__.py
@@ -21,12 +21,16 @@
 class ThrottleEvent (object):
     """
     ThrottleEvent contains details about a throttled request.
+    Set up a throttle callback by setting the ``throttle_cb`` configuration
+    property to a callable that takes a ThrottleEvent object as its only argument.
+    The callback will be triggered from poll(), consume() or flush() when a request
+    has been throttled by the broker.
 
     This class is typically not user instantiated.
 
-    :ivar broker_name str: The hostname of the broker which throttled the request
-    :ivar broker_id int: The broker id
-    :ivar throttle_time float: The amount of time (in seconds) the broker throttled (delayed) the request
+    :ivar str broker_name: The hostname of the broker which throttled the request
+    :ivar int broker_id: The broker id
+    :ivar float throttle_time: The amount of time (in seconds) the broker throttled (delayed) the request
     """
     def __init__(self, broker_name,
                  broker_id,
diff --git a/confluent_kafka/src/confluent_kafka.c b/confluent_kafka/src/confluent_kafka.c
@@ -1199,7 +1199,7 @@ static void throttle_cb (rd_kafka_t *rk, const char *broker_name, int32_t broker
                          int throttle_time_ms, void *opaque) {
         Handle *h = opaque;
         PyObject *ThrottleEvent_type, *throttle_event;
-        PyObject *result, *kwargs, *args;
+        PyObject *result, *args;
         CallState *cs;
 
         cs = CallState_get(h);
diff --git a/docs/index.rst b/docs/index.rst
@@ -84,6 +84,12 @@ Logical offset constants:
  * :py:const:`OFFSET_STORED` - Use stored/committed offset
  * :py:const:`OFFSET_INVALID` - Invalid/Default offset
 
+*************
+ThrottleEvent
+*************
+
+.. autoclass:: confluent_kafka.ThrottleEvent
+   :members:
 
 
 Configuration
