46/f4109b03e30c404a2d6dfb8bc61e430888a59f

   1 Return-Path: <teythoon@jade-hamburg.de>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 8CD1D431FD0\r
   6         for <notmuch@notmuchmail.org>; Thu, 29 Sep 2011 18:05:21 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0.001\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0.001 tagged_above=-999 required=5\r
  12         tests=[UNPARSEABLE_RELAY=0.001] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id 7ZR24aqm0DE8 for <notmuch@notmuchmail.org>;\r
  16         Thu, 29 Sep 2011 18:05:21 -0700 (PDT)\r
  17 Received: from mail.cryptobitch.de (cryptobitch.de [88.198.7.68])\r
  18         (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id E9C85431FB6\r
  21         for <notmuch@notmuchmail.org>; Thu, 29 Sep 2011 18:05:20 -0700 (PDT)\r
  22 Received: from mail.jade-hamburg.de (unknown [85.183.11.228])\r
  23         (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
  24         (No client certificate requested)\r
  25         by mail.cryptobitch.de (Postfix) with ESMTPSA id 55609505D41\r
  26         for <notmuch@notmuchmail.org>; Fri, 30 Sep 2011 03:05:19 +0200 (CEST)\r
  27 Received: by mail.jade-hamburg.de (Postfix, from userid 401)\r
  28         id AD9A3DF28B; Fri, 30 Sep 2011 03:05:18 +0200 (CEST)\r
  29 Received: from thinkbox.jade-hamburg.de (unknown\r
  30         [IPv6:fe80::216:d3ff:fe3e:5058%br0])\r
  31         (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
  32         (No client certificate requested) (Authenticated sender: teythoon)\r
  33         by mail.jade-hamburg.de (Postfix) with ESMTPSA id 39D95DF28B;\r
  34         Fri, 30 Sep 2011 03:05:14 +0200 (CEST)\r
  35 Received: from teythoon by thinkbox.jade-hamburg.de with local (Exim 4.76)\r
  36         (envelope-from <teythoon@thinkbox.jade-hamburg.de>)\r
  37         id 1R9RXM-0004SH-V7; Fri, 30 Sep 2011 03:05:13 +0200\r
  38 From: Justus Winter <4winter@informatik.uni-hamburg.de>\r
  39 To: notmuch@notmuchmail.org\r
  40 Subject: [PATCH] python: fix docstring of Message.get_header()\r
  41 Date: Fri, 30 Sep 2011 03:05:04 +0200\r
  42 Message-Id:\r
  43  <1317344704-17056-1-git-send-email-4winter@informatik.uni-hamburg.de>\r
  44 X-Mailer: git-send-email 1.7.6.3\r
  45 X-BeenThere: notmuch@notmuchmail.org\r
  46 X-Mailman-Version: 2.1.13\r
  47 Precedence: list\r
  48 List-Id: "Use and development of the notmuch mail system."\r
  49         <notmuch.notmuchmail.org>\r
  50 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  51         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  52 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  53 List-Post: <mailto:notmuch@notmuchmail.org>\r
  54 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  55 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  56         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  57 X-List-Received-Date: Fri, 30 Sep 2011 01:05:21 -0000\r
  58 \r
  59 Update the docstring from notmuch.h.\r
  60 \r
  61 Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>\r
  62 ---\r
  63  bindings/python/notmuch/message.py |   13 +++++++------\r
  64  1 files changed, 7 insertions(+), 6 deletions(-)\r
  65 \r
  66 diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py\r
  67 index 0c3365b..4bf90c2 100644\r
  68 --- a/bindings/python/notmuch/message.py\r
  69 +++ b/bindings/python/notmuch/message.py\r
  70 @@ -369,22 +369,23 @@ class Message(object):\r
  71          return Message._get_date(self._msg)\r
  72  \r
  73      def get_header(self, header):\r
  74 -        """Returns a message header\r
  75 +        """Get the value of the specified header.\r
  76  \r
  77 -        This returns any message header that is stored in the notmuch database.\r
  78 -        This is only a selected subset of headers, which is currently:\r
  79 +        The value will be read from the actual message file, not from\r
  80 +        the notmuch database. The header name is case insensitive.\r
  81  \r
  82 -          TODO: add stored headers\r
  83 +        Returns an empty string ("") if the message does not contain a\r
  84 +        header line matching 'header'.\r
  85  \r
  86          :param header: The name of the header to be retrieved.\r
  87 -                       It is not case-sensitive (TODO: confirm).\r
  88 +                       It is not case-sensitive.\r
  89          :type header: str\r
  90          :returns: The header value as string\r
  91          :exception: :exc:`NotmuchError`\r
  92  \r
  93                      * STATUS.NOT_INITIALIZED if the message\r
  94                        is not initialized.\r
  95 -                    * STATUS.NULL_POINTER, if no header was found\r
  96 +                    * STATUS.NULL_POINTER if any error occured.\r
  97          """\r
  98          if self._msg is None:\r
  99              raise NotmuchError(STATUS.NOT_INITIALIZED)\r
 100 -- \r
 101 1.7.6.3\r
 102 \r