From: Michael J Gruber <git@grubix.eu>
Date: Tue, 4 Mar 2025 12:39:43 +0000 (+0100)
Subject: bindings/python-cffi: fix docstring for message.header()
X-Git-Tag: archive/debian/0.39_rc3-1~3
X-Git-Url: https://git.notmuchmail.org/git?a=commitdiff_plain;h=5802f5d6269172222a6fccf5908eae833014917b;p=notmuch

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

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.
---

diff --git a/bindings/python-cffi/notmuch2/_message.py b/bindings/python-cffi/notmuch2/_message.py
index f4c7ef02..7bd20331 100644
--- a/bindings/python-cffi/notmuch2/_message.py
+++ b/bindings/python-cffi/notmuch2/_message.py
@@ -240,8 +240,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.