Patch 1 (#650)

* docstring for header support in Producer.send closes #566 * news fragment
aio-libs · Oct 16, 2020 · 5622e9b · 5622e9b
1 parent 84e2a98
commit 5622e9b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGES/566.doc b/CHANGES/566.doc
@@ -0,0 +1 @@
+Added a docstring for Kafka header support in Producer.send().
diff --git a/aiokafka/producer/producer.py b/aiokafka/producer/producer.py
@@ -396,6 +396,9 @@ async def send(
                 key_serializer.
             timestamp_ms (int, optional): epoch milliseconds (from Jan 1 1970
                 UTC) to use as the message timestamp. Defaults to current time.
+            headers (optional): Kafka headers to be included in the message using
+                the format [("key", b"value")]. Iterable of tuples where key is a
+                normal string and value is a byte string.
 
         Returns:
             asyncio.Future: object that will be set when message is