(pulsar-client-python) branch main updated: Document the requirement for the send_async method (#186)

[xy...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xyz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-client-python.git


The following commit(s) were added to refs/heads/main by this push:
     new d2fb04e  Document the requirement for the send_async method (#186)
d2fb04e is described below

commit d2fb04e5afc8c4ba24e11771059eff0e465a7f61
Author: Yunze Xu <xy...@163.com>
AuthorDate: Thu Dec 28 14:55:09 2023 +0800

    Document the requirement for the send_async method (#186)
    
    See https://github.com/apache/pulsar-client-python/issues/184
    
    It should be documented that the callback should not throw any exception
    when passed to `send_async`.
---
 pulsar/__init__.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pulsar/__init__.py b/pulsar/__init__.py
index 92cf10f..a44a0db 100644
--- a/pulsar/__init__.py
+++ b/pulsar/__init__.py
@@ -1237,6 +1237,8 @@ class Producer:
         --------
 
         The ``callback`` will be invoked once the message has been acknowledged by the broker.
+        Users are responsible to handle the exception inside the callback. If any exception was
+        thrown from the callback, the process would terminate immediately.
 
         .. code-block:: python