Fix constructor doc (confluentinc#321) (confluentinc#397)

Ryan P · web-flow · commit 6e7a10bbe2b5 · 2018-06-08T05:19:40.000-04:00
diff --git a/confluent_kafka/src/Consumer.c b/confluent_kafka/src/Consumer.c
@@ -1411,25 +1411,28 @@ PyTypeObject ConsumerType = {
 	0,                         /*tp_as_buffer*/
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
 	Py_TPFLAGS_HAVE_GC, /*tp_flags*/
-	"High-level Kafka Consumer\n"
-	"\n"
-	".. py:function:: Consumer(**kwargs)\n"
-	"\n"
-	"  Create new Consumer instance using provided configuration dict.\n"
-	"\n"
-	" Special configuration properties:\n"
-	"   ``on_commit``: Optional callback will be called when a commit "
-	"request has succeeded or failed.\n"
-	"\n"
-	"\n"
-	".. py:function:: on_commit(err, partitions)\n"
-	"\n"
-	"  :param Consumer consumer: Consumer instance.\n"
-	"  :param KafkaError err: Commit error object, or None on success.\n"
-	"  :param list(TopicPartition) partitions: List of partitions with "
-	"their committed offsets or per-partition errors.\n"
-	"\n"
-	"\n", /*tp_doc*/
+        "High-level Kafka Consumer\n"
+        "\n"
+        ".. py:function:: Consumer(config)\n"
+        "\n"
+        "  :param dict config: Configuration properties. At a minimum ``bootstrap.servers`` and "
+        "``group.id`` **should** be set"
+        "\n"
+        "Create new Consumer instance using provided configuration dict.\n"
+        "\n"
+        " Special configuration properties:\n"
+                "   ``on_commit``: Optional callback will be called when a commit "
+        "request has succeeded or failed.\n"
+        "\n"
+        "\n"
+        ".. py:function:: on_commit(err, partitions)\n"
+        "\n"
+        "  :param Consumer consumer: Consumer instance.\n"
+        "  :param KafkaError err: Commit error object, or None on success.\n"
+        "  :param list(TopicPartition) partitions: List of partitions with "
+        "their committed offsets or per-partition errors.\n"
+        "\n"
+        "\n", /*tp_doc*/
 	(traverseproc)Consumer_traverse, /* tp_traverse */
 	(inquiry)Consumer_clear, /* tp_clear */
 	0,		           /* tp_richcompare */
diff --git a/confluent_kafka/src/Producer.c b/confluent_kafka/src/Producer.c
@@ -633,18 +633,20 @@ PyTypeObject ProducerType = {
 	0,                         /*tp_as_buffer*/
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
 	Py_TPFLAGS_HAVE_GC, /*tp_flags*/
-	"Asynchronous Kafka Producer\n"
-	"\n"
-	".. py:function:: Producer(**kwargs)\n"
-	"\n"
-	"  Create new Producer instance using provided configuration dict.\n"
-	"\n"
-	"\n"
-	".. py:function:: len()\n"
-	"\n"
-	"  :returns: Number of messages and Kafka protocol requests waiting to be delivered to broker.\n"
-	"  :rtype: int\n"
-	"\n", /*tp_doc*/
+        "Asynchronous Kafka Producer\n"
+        "\n"
+        ".. py:function:: Producer(config)\n"
+        "\n"
+        "  :param dict config: Configuration properties. At a minimum ``bootstrap.servers`` **should** be set\n"
+        "\n"
+        "  Create new Producer instance using provided configuration dict.\n"
+        "\n"
+        "\n"
+        ".. py:function:: len()\n"
+        "\n"
+        "  :returns: Number of messages and Kafka protocol requests waiting to be delivered to broker.\n"
+        "  :rtype: int\n"
+        "\n", /*tp_doc*/
 	(traverseproc)Producer_traverse, /* tp_traverse */
 	(inquiry)Producer_clear, /* tp_clear */
 	0,		           /* tp_richcompare */
