Document unit (Seconds) for timeout parameters (closes confluentinc#285)

edenhill · edenhill · commit 3456dedf8bf8 · 2018-02-13T22:16:16.000+01:00
diff --git a/confluent_kafka/src/Consumer.c b/confluent_kafka/src/Consumer.c
@@ -988,7 +988,7 @@ static PyMethodDef Consumer_methods[] = {
 	  "  .. note: Callbacks may be called from this method, "
 	  "such as ``on_assign``, ``on_revoke``, et.al.\n"
 	  "\n"
-	  "  :param float timeout: Maximum time to block waiting for message, event or callback.\n"
+	  "  :param float timeout: Maximum time to block waiting for message, event or callback. (Seconds)\n"
 	  "  :returns: A Message object or None on timeout\n"
 	  "  :rtype: :py:class:`Message` or None\n"
       "  :raises: RuntimeError if called on a closed consumer\n"
@@ -1011,7 +1011,7 @@ static PyMethodDef Consumer_methods[] = {
 	  "such as ``on_assign``, ``on_revoke``, et.al.\n"
 	  "\n"
 	  "  :param int num_messages: Maximum number of messages to return (default: 1).\n"
-	  "  :param float timeout: Maximum time to block waiting for message, event or callback (default: infinite (-1)).\n"
+	  "  :param float timeout: Maximum time to block waiting for message, event or callback (default: infinite (-1)). (Seconds)\n"
 	  "  :returns: A list of Message objects (possibly empty on timeout)\n"
 	  "  :rtype: list(Message)\n"
           "  :raises: RuntimeError if called on a closed consumer, KafkaError "
@@ -1090,7 +1090,7 @@ static PyMethodDef Consumer_methods[] = {
 	  "\n"
 	  "  :param list(TopicPartition) partitions: List of topic+partitions "
 	  "to query for stored offsets.\n"
-	  "  :param float timeout: Request timeout\n"
+	  "  :param float timeout: Request timeout. (Seconds)\n"
 	  "  :returns: List of topic+partitions with offset and possibly error set.\n"
 	  "  :rtype: list(TopicPartition)\n"
 	  "  :raises: KafkaException\n"
@@ -1143,7 +1143,7 @@ static PyMethodDef Consumer_methods[] = {
           "  Retrieve low and high offsets for partition.\n"
           "\n"
           "  :param TopicPartition partition: Topic+partition to return offsets for."
-          "  :param float timeout: Request timeout (when cached=False).\n"
+          "  :param float timeout: Request timeout (when cached=False). (Seconds)\n"
           "  :param bool cached: Instead of querying the broker used cached information. "
           "Cached values: The low offset is updated periodically (if statistics.interval.ms is set) while "
           "the high offset is updated on each message fetched from the broker for this partition."
@@ -1164,7 +1164,7 @@ static PyMethodDef Consumer_methods[] = {
           " corresponding partition.\n"
           "\n"
           "  :param list(TopicPartition) partitions: topic+partitions with timestamps in the TopicPartition.offset field."
-          "  :param float timeout: Request timeout.\n"
+          "  :param float timeout: Request timeout. (Seconds)\n"
           "  :returns: list of topic+partition with offset field set and possibly error set\n"
           "  :rtype: list(TopicPartition)\n"
           "  :raises: KafkaException\n"
diff --git a/confluent_kafka/src/Producer.c b/confluent_kafka/src/Producer.c
@@ -488,7 +488,7 @@ static PyMethodDef Producer_methods[] = {
 	  "  - ``on_delivery`` callbacks from :py:func:`produce()`\n"
 	  "  - ...\n"
 	  "\n"
-	  "  :param float timeout: Maximum time to block waiting for events.\n"
+	  "  :param float timeout: Maximum time to block waiting for events. (Seconds)\n"
 	  "  :returns: Number of events processed (callbacks served)\n"
 	  "  :rtype: int\n"
 	  "\n"
@@ -501,7 +501,7 @@ static PyMethodDef Producer_methods[] = {
 	  "   This is a convenience method that calls :py:func:`poll()` until "
 	  ":py:func:`len()` is zero or the optional timeout elapses.\n"
 	  "\n"
-          "  :param: float timeout: Maximum time to block (requires librdkafka >= v0.9.4).\n"
+          "  :param: float timeout: Maximum time to block (requires librdkafka >= v0.9.4). (Seconds)\n"
           "  :returns: Number of messages still in queue.\n"
           "\n"
 	  ".. note:: See :py:func:`poll()` for a description on what "
