Skip to content

Commit 2f9187a

Browse files
hrchuedenhill
authored andcommitted
Update commit_cb docs on synchronous use (@hrchu)
1 parent 6058401 commit 2f9187a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The Python bindings also provide some additional configuration properties:
135135
had headers set. This callback is served upon calling ``producer.poll()`` or ``producer.flush()``.
136136

137137
* ``on_commit(kafka.KafkaError, list(kafka.TopicPartition))`` (**Consumer**): Callback used to indicate success or failure
138-
of commit requests. This callback is served upon calling ``consumer.poll()``.
138+
of asynchronous and automatic commit requests. This callback is served upon calling ``consumer.poll()``. Is not triggered for synchronous commits.
139139

140140
* ``logger=logging.Handler`` kwarg: forward logs from the Kafka client to the
141141
provided ``logging.Handler`` instance.

0 commit comments

Comments
 (0)