API doc

astrolabsoftware · Sep 8, 2023 · 75cc848 · 75cc848
1 parent 6fd5c36
commit 75cc848
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/fink_client/consumer.py b/fink_client/consumer.py
@@ -64,6 +64,19 @@ def __exit__(self, type, value, traceback):
         self._consumer.close()
 
     def process_message(self, msg):
+        """ Process message from Kafka
+
+        Parameters
+        ----------
+        msg: confluent_kafka.Message
+            Object containing message information
+
+        Returns
+        ----------
+        list: [tuple(str, dict, str)]
+            list of topic, alert, key
+            returns an empty list on timeout
+        """
         # msg.error() returns None or KafkaError
         if msg.error():
             error_message = """