Skip to content

Commit d7239ee

Browse files
committed
Documented parameters of callbacks
1 parent fa80712 commit d7239ee

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ The Python bindings also provide some additional configuration properties:
7878
* ``default.topic.config``: value is a dict of topic-level configuration
7979
properties that are applied to all used topics for the instance.
8080

81-
* ``error_cb``: Callback for generic/global error events. This callback is served by
81+
* ``error_cb(kafka.KafkaError)``: Callback for generic/global error events. This callback is served by
8282
poll().
8383

84-
* ``on_delivery`` (**Producer**): value is a Python function reference
84+
* ``on_delivery(kafka.KafkaError, kafka.Message)`` (**Producer**): value is a Python function reference
8585
that is called once for each produced message to indicate the final
8686
delivery result (success or failure).
8787
This property may also be set per-message by passing ``callback=callable``
8888
(or ``on_delivery=callable``) to the confluent_kafka.Producer.produce() function.
8989

90-
* ``on_commit`` (**Consumer**): Callback used to indicate success or failure
90+
* ``on_commit(kafka.KafkaError, list(kafka.TopicPartition))`` (**Consumer**): Callback used to indicate success or failure
9191
of commit requests.

0 commit comments

Comments
 (0)