Skip to content

Commit 784b1ed

Browse files
committed
docs: add docstring back:
1 parent 34ca90c commit 784b1ed

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

pulsar/asyncio.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,19 @@ async def negative_acknowledge(
324324
self,
325325
message: Union[pulsar.Message, pulsar.MessageId, _pulsar.Message, _pulsar.MessageId]
326326
) -> None:
327+
"""
328+
Acknowledge the failure to process a single message asynchronously.
329+
330+
When a message is "negatively acked" it will be marked for redelivery after
331+
some fixed delay. The delay is configurable when constructing the consumer
332+
with {@link ConsumerConfiguration#setNegativeAckRedeliveryDelayMs}.
333+
This call is not blocking.
334+
335+
Parameters
336+
----------
337+
message:
338+
The received message or message id.
339+
"""
327340
if isinstance(message, pulsar.Message):
328341
msg = message._message
329342
elif isinstance(message, pulsar.MessageId):

0 commit comments

Comments
 (0)