Return-Path: X-Original-To: notmuch@notmuchmail.org Delivered-To: notmuch@notmuchmail.org Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 8CD1D431FD0 for ; Thu, 29 Sep 2011 18:05:21 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0.001 X-Spam-Level: X-Spam-Status: No, score=0.001 tagged_above=-999 required=5 tests=[UNPARSEABLE_RELAY=0.001] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 7ZR24aqm0DE8 for ; Thu, 29 Sep 2011 18:05:21 -0700 (PDT) Received: from mail.cryptobitch.de (cryptobitch.de [88.198.7.68]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id E9C85431FB6 for ; Thu, 29 Sep 2011 18:05:20 -0700 (PDT) Received: from mail.jade-hamburg.de (unknown [85.183.11.228]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by mail.cryptobitch.de (Postfix) with ESMTPSA id 55609505D41 for ; Fri, 30 Sep 2011 03:05:19 +0200 (CEST) Received: by mail.jade-hamburg.de (Postfix, from userid 401) id AD9A3DF28B; Fri, 30 Sep 2011 03:05:18 +0200 (CEST) Received: from thinkbox.jade-hamburg.de (unknown [IPv6:fe80::216:d3ff:fe3e:5058%br0]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: teythoon) by mail.jade-hamburg.de (Postfix) with ESMTPSA id 39D95DF28B; Fri, 30 Sep 2011 03:05:14 +0200 (CEST) Received: from teythoon by thinkbox.jade-hamburg.de with local (Exim 4.76) (envelope-from ) id 1R9RXM-0004SH-V7; Fri, 30 Sep 2011 03:05:13 +0200 From: Justus Winter <4winter@informatik.uni-hamburg.de> To: notmuch@notmuchmail.org Subject: [PATCH] python: fix docstring of Message.get_header() Date: Fri, 30 Sep 2011 03:05:04 +0200 Message-Id: <1317344704-17056-1-git-send-email-4winter@informatik.uni-hamburg.de> X-Mailer: git-send-email 1.7.6.3 X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Sep 2011 01:05:21 -0000 Update the docstring from notmuch.h. Signed-off-by: Justus Winter <4winter@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