@@ -1411,25 +1411,28 @@ PyTypeObject ConsumerType = {
1411
1411
0 , /*tp_as_buffer*/
1412
1412
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
1413
1413
Py_TPFLAGS_HAVE_GC , /*tp_flags*/
1414
- "High-level Kafka Consumer\n"
1415
- "\n"
1416
- ".. py:function:: Consumer(**kwargs)\n"
1417
- "\n"
1418
- " Create new Consumer instance using provided configuration dict.\n"
1419
- "\n"
1420
- " Special configuration properties:\n"
1421
- " ``on_commit``: Optional callback will be called when a commit "
1422
- "request has succeeded or failed.\n"
1423
- "\n"
1424
- "\n"
1425
- ".. py:function:: on_commit(err, partitions)\n"
1426
- "\n"
1427
- " :param Consumer consumer: Consumer instance.\n"
1428
- " :param KafkaError err: Commit error object, or None on success.\n"
1429
- " :param list(TopicPartition) partitions: List of partitions with "
1430
- "their committed offsets or per-partition errors.\n"
1431
- "\n"
1432
- "\n" , /*tp_doc*/
1414
+ "High-level Kafka Consumer\n"
1415
+ "\n"
1416
+ ".. py:function:: Consumer(config)\n"
1417
+ "\n"
1418
+ " :param dict config: Configuration properties. At a minimum ``bootstrap.servers`` and "
1419
+ "``group.id`` **should** be set"
1420
+ "\n"
1421
+ "Create new Consumer instance using provided configuration dict.\n"
1422
+ "\n"
1423
+ " Special configuration properties:\n"
1424
+ " ``on_commit``: Optional callback will be called when a commit "
1425
+ "request has succeeded or failed.\n"
1426
+ "\n"
1427
+ "\n"
1428
+ ".. py:function:: on_commit(err, partitions)\n"
1429
+ "\n"
1430
+ " :param Consumer consumer: Consumer instance.\n"
1431
+ " :param KafkaError err: Commit error object, or None on success.\n"
1432
+ " :param list(TopicPartition) partitions: List of partitions with "
1433
+ "their committed offsets or per-partition errors.\n"
1434
+ "\n"
1435
+ "\n" , /*tp_doc*/
1433
1436
(traverseproc )Consumer_traverse , /* tp_traverse */
1434
1437
(inquiry )Consumer_clear , /* tp_clear */
1435
1438
0 , /* tp_richcompare */
0 commit comments