[PATCH] python: fix docstring of Message.get_header()
Justus Winter
4winter at informatik.uni-hamburg.de
Thu Sep 29 18:05:04 PDT 2011
Update the docstring from notmuch.h.
Signed-off-by: Justus Winter <4winter at informatik.uni-hamburg.de>
---
bindings/python/notmuch/message.py | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py
index 0c3365b..4bf90c2 100644
--- a/bindings/python/notmuch/message.py
+++ b/bindings/python/notmuch/message.py
@@ -369,22 +369,23 @@ class Message(object):
return Message._get_date(self._msg)
def get_header(self, header):
- """Returns a message header
+ """Get the value of the specified header.
- This returns any message header that is stored in the notmuch database.
- This is only a selected subset of headers, which is currently:
+ The value will be read from the actual message file, not from
+ the notmuch database. The header name is case insensitive.
- TODO: add stored headers
+ Returns an empty string ("") if the message does not contain a
+ header line matching 'header'.
:param header: The name of the header to be retrieved.
- It is not case-sensitive (TODO: confirm).
+ It is not case-sensitive.
:type header: str
:returns: The header value as string
:exception: :exc:`NotmuchError`
* STATUS.NOT_INITIALIZED if the message
is not initialized.
- * STATUS.NULL_POINTER, if no header was found
+ * STATUS.NULL_POINTER if any error occured.
"""
if self._msg is None:
raise NotmuchError(STATUS.NOT_INITIALIZED)
--
1.7.6.3
More information about the notmuch
mailing list