[PATCH] bindings/python-cffi: fix docstring for message.header()

Subject: [PATCH] bindings/python-cffi: fix docstring for message.header()

Date: Tue, 4 Mar 2025 13:39:43 +0100

To: notmuch@notmuchmail.org

Cc: Michael J Gruber

From: michaeljgruber+grubix+git@gmail.com

From: Michael J Gruber <git@grubix.eu>

The cffi bindings raise a LookupError in case a header is not present.
Adjust the docstring to say so.

The legacy bindings behaved differently, and this is one of the things
to be aware of when migrating to the cffi bindings.
---
 bindings/python-cffi/notmuch2/_message.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/bindings/python-cffi/notmuch2/_message.py b/bindings/python-cffi/notmuch2/_message.py
index 4c196074..24a22c15 100644
--- a/bindings/python-cffi/notmuch2/_message.py
+++ b/bindings/python-cffi/notmuch2/_message.py
@@ -246,8 +246,7 @@ class Message(base.NotmuchObject):
         :param header: Case-insensitive header name to retrieve.
         :type header: str or bytes
 
-        :returns: The header value, an empty string if the header is
-           not present.
+        :returns: The header value.
         :rtype: str
 
         :raises LookupError: if the header is not present.
-- 
2.49.0.rc0.432.g866148343a

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: