--- /dev/null
+Return-Path: <patricktotzke@googlemail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 8258A429E32\r
+ for <notmuch@notmuchmail.org>; Mon, 5 Dec 2011 13:13:08 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+ tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+ FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id tYnBGKjkRaIw for <notmuch@notmuchmail.org>;\r
+ Mon, 5 Dec 2011 13:13:05 -0800 (PST)\r
+Received: from mail-ee0-f53.google.com (mail-ee0-f53.google.com\r
+ [74.125.83.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client\r
+ certificate requested) by olra.theworths.org (Postfix) with ESMTPS id\r
+ 51E8B429E36 for <notmuch@notmuchmail.org>; Mon, 5 Dec 2011 13:13:04 -0800\r
+ (PST)\r
+Received: by mail-ee0-f53.google.com with SMTP id b57so1074011eek.26\r
+ for <notmuch@notmuchmail.org>; Mon, 05 Dec 2011 13:13:04 -0800 (PST)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=googlemail.com; s=gamma;\r
+ h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+ bh=RWIIiF5DuOor+mGKND/Dx+wgqr8PpPFctTNJ2oVtW1g=;\r
+ b=Cf9sObHzx5wIxDD4LTH1N7xaTkMQtrn4jcwfm/+Syiuynn1b6o89VO0tBYrGyHv61D\r
+ Hmk73omWMKUecRCGv6xVCqvWVzkvCFc6c/lXDzH7nlQ4Wsfz7/tXTT9vbU7vXaJdxZ+h\r
+ y0BRsHz/i3QNsFJnTGAHYH+Ok+fnp6Nu9ccuM=\r
+Received: by 10.14.9.210 with SMTP id 58mr1484128eet.123.1323119583798;\r
+ Mon, 05 Dec 2011 13:13:03 -0800 (PST)\r
+Received: from localhost (cpc1-sgyl2-0-0-cust548.18-2.cable.virginmedia.com.\r
+ [82.41.10.37])\r
+ by mx.google.com with ESMTPS id 65sm38883529eeg.8.2011.12.05.13.13.01\r
+ (version=TLSv1/SSLv3 cipher=OTHER);\r
+ Mon, 05 Dec 2011 13:13:02 -0800 (PST)\r
+From: Patrick Totzke <patricktotzke@googlemail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 3/3] fix sphinx compile-time warnings\r
+Date: Mon, 5 Dec 2011 21:12:35 +0000\r
+Message-Id: <1323119555-31416-4-git-send-email-patricktotzke@gmail.com>\r
+X-Mailer: git-send-email 1.7.4.1\r
+In-Reply-To: <1323119555-31416-1-git-send-email-patricktotzke@gmail.com>\r
+References: <1323119555-31416-1-git-send-email-patricktotzke@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 05 Dec 2011 21:13:08 -0000\r
+\r
+no changes to the code, only makes compiling the docs smoother\r
+as some rsT syntax errors were fixed\r
+---\r
+ bindings/python/docs/source/index.rst | 17 ++++----\r
+ bindings/python/notmuch/database.py | 67 ++++++++++++++++++--------------\r
+ bindings/python/notmuch/message.py | 27 +++++++------\r
+ bindings/python/notmuch/tag.py | 11 +++--\r
+ 4 files changed, 68 insertions(+), 54 deletions(-)\r
+\r
+diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst\r
+index 73d2a3b..f7d3d60 100644\r
+--- a/bindings/python/docs/source/index.rst\r
++++ b/bindings/python/docs/source/index.rst\r
+@@ -138,10 +138,10 @@ More information on specific topics can be found on the following pages:\r
+ \r
+ .. method:: __len__()\r
+ \r
+- .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted\r
+- the iterator and broke list(Messages()). Use the\r
+- :meth:`Query.count_messages` function or use\r
+- `len(list(msgs))`.\r
++ .. warning::\r
++ \r
++ :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke\r
++ list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`.\r
+ \r
+ :class:`Message` -- A single message\r
+ ----------------------------------------\r
+@@ -205,10 +205,11 @@ More information on specific topics can be found on the following pages:\r
+ \r
+ .. method:: __len__\r
+ \r
+- .. warning:: :meth:`__len__` was removed in version 0.6 as it\r
+- exhausted the iterator and broke list(Tags()). Use\r
+- :meth:`len(list(msgs))` instead if you need to know the\r
+- number of tags.\r
++ .. warning::\r
++\r
++ :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke\r
++ list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of\r
++ tags.\r
+ \r
+ .. automethod:: __str__\r
+ \r
+diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py\r
+index 706e8c8..471adaa 100644\r
+--- a/bindings/python/notmuch/database.py\r
++++ b/bindings/python/notmuch/database.py\r
+@@ -40,16 +40,19 @@ class Database(object):\r
+ :exc:`XapianError` as the underlying database has been\r
+ modified. Close and reopen the database to continue working with it.\r
+ \r
+- .. note:: Any function in this class can and will throw an\r
+- :exc:`NotInitializedError` if the database was not\r
+- intitialized properly.\r
+-\r
+- .. note:: Do remember that as soon as we tear down (e.g. via `del\r
+- db`) this object, all underlying derived objects such as\r
+- queries, threads, messages, tags etc will be freed by the\r
+- underlying library as well. Accessing these objects will lead\r
+- to segfaults and other unexpected behavior. See above for\r
+- more details.\r
++ .. note::\r
++\r
++ Any function in this class can and will throw an\r
++ :exc:`NotInitializedError` if the database was not intitialized\r
++ properly.\r
++\r
++ .. note::\r
++\r
++ Do remember that as soon as we tear down (e.g. via `del db`) this\r
++ object, all underlying derived objects such as queries, threads,\r
++ messages, tags etc will be freed by the underlying library as well.\r
++ Accessing these objects will lead to segfaults and other unexpected\r
++ behavior. See above for more details.\r
+ """\r
+ _std_db_path = None\r
+ """Class attribute to cache user's default database"""\r
+@@ -253,10 +256,8 @@ class Database(object):\r
+ neither begin nor end necessarily flush modifications to disk.\r
+ \r
+ :returns: :attr:`STATUS`.SUCCESS or raises\r
+-\r
+- :exception: :exc:`NotmuchError`:\r
+- :attr:`STATUS`.XAPIAN_EXCEPTION\r
+- Xapian exception occurred; atomic section not entered.\r
++ :exception: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION\r
++ Xapian exception occurred; atomic section not entered.\r
+ \r
+ *Added in notmuch 0.9*"""\r
+ self._assert_db_is_initialized()\r
+@@ -295,9 +296,11 @@ class Database(object):\r
+ """Returns a :class:`Directory` of path,\r
+ (creating it if it does not exist(?))\r
+ \r
+- .. warning:: This call needs a writeable database in\r
+- :attr:`Database.MODE`.READ_WRITE mode. The underlying library will\r
+- exit the program if this method is used on a read-only database!\r
++ .. warning::\r
++\r
++ This call needs a writeable database in\r
++ :attr:`Database.MODE`.READ_WRITE mode. The underlying library will\r
++ exit the program if this method is used on a read-only database!\r
+ \r
+ :param path: An unicode string containing the path relative to the path\r
+ of database (see :meth:`get_path`), or else should be an absolute\r
+@@ -459,10 +462,11 @@ class Database(object):\r
+ def find_message_by_filename(self, filename):\r
+ """Find a message with the given filename\r
+ \r
+- .. warning:: This call needs a writeable database in\r
+- :attr:`Database.MODE`.READ_WRITE mode. The underlying library will\r
+- exit the program if this method is used on a read-only\r
+- database!\r
++ .. warning::\r
++\r
++ This call needs a writeable database in\r
++ :attr:`Database.MODE`.READ_WRITE mode. The underlying library will\r
++ exit the program if this method is used on a read-only database!\r
+ \r
+ :returns: If the database contains a message with the given\r
+ filename, then a class:`Message:` is returned. This\r
+@@ -791,10 +795,12 @@ class Directory(object):\r
+ and know that it only needs to add files if the mtime of the\r
+ directory and files are newer than the stored timestamp.\r
+ \r
+- .. note:: :meth:`get_mtime` function does not allow the caller\r
+- to distinguish a timestamp of 0 from a non-existent\r
+- timestamp. So don't store a timestamp of 0 unless you are\r
+- comfortable with that.\r
++ .. note::\r
++\r
++ :meth:`get_mtime` function does not allow the caller to\r
++ distinguish a timestamp of 0 from a non-existent timestamp. So\r
++ don't store a timestamp of 0 unless you are comfortable with\r
++ that.\r
+ \r
+ :param mtime: A (time_t) timestamp\r
+ :returns: Nothing on success, raising an exception on failure.\r
+@@ -928,13 +934,16 @@ class Filenames(object):\r
+ def __len__(self):\r
+ """len(:class:`Filenames`) returns the number of contained files\r
+ \r
+- .. note:: As this iterates over the files, we will not be able to\r
+- iterate over them again! So this will fail::\r
++ .. note::\r
++\r
++ As this iterates over the files, we will not be able to\r
++ iterate over them again! So this will fail::\r
+ \r
+ #THIS FAILS\r
+ files = Database().get_directory('').get_child_files()\r
+- if len(files) > 0: #this 'exhausts' msgs\r
+- # next line raises NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)!!!\r
++ if len(files) > 0: # this 'exhausts' msgs\r
++ # next line raises\r
++ # NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)\r
+ for file in files: print file\r
+ """\r
+ if self._files_p is None:\r
+diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py\r
+index 2534742..2f0fd92 100644\r
+--- a/bindings/python/notmuch/message.py\r
++++ b/bindings/python/notmuch/message.py\r
+@@ -127,10 +127,12 @@ class Messages(object):\r
+ """Return the unique :class:`Tags` in the contained messages\r
+ \r
+ :returns: :class:`Tags`\r
+- :exceptions: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if not inited\r
++ :exceptions: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if not init'ed\r
+ \r
+- .. note:: :meth:`collect_tags` will iterate over the messages and\r
+- therefore will not allow further iterations.\r
++ .. note::\r
++\r
++ :meth:`collect_tags` will iterate over the messages and therefore\r
++ will not allow further iterations.\r
+ """\r
+ if self._msgs is None:\r
+ raise NotmuchError(STATUS.NOT_INITIALIZED)\r
+@@ -358,14 +360,15 @@ class Message(object):\r
+ """Gets all direct replies to this message as :class:`Messages`\r
+ iterator\r
+ \r
+- .. note:: This call only makes sense if 'message' was\r
+- ultimately obtained from a :class:`Thread` object, (such as\r
+- by coming directly from the result of calling\r
+- :meth:`Thread.get_toplevel_messages` or by any number of\r
+- subsequent calls to :meth:`get_replies`). If this message was\r
+- obtained through some non-thread means, (such as by a call\r
+- to :meth:`Query.search_messages`), then this function will\r
+- return `None`.\r
++ .. note::\r
++\r
++ This call only makes sense if 'message' was ultimately obtained from\r
++ a :class:`Thread` object, (such as by coming directly from the\r
++ result of calling :meth:`Thread.get_toplevel_messages` or by any\r
++ number of subsequent calls to :meth:`get_replies`). If this message\r
++ was obtained through some non-thread means, (such as by a call to\r
++ :meth:`Query.search_messages`), then this function will return\r
++ `None`.\r
+ \r
+ :returns: :class:`Messages` or `None` if there are no replies to\r
+ this message.\r
+@@ -646,7 +649,7 @@ class Message(object):\r
+ \r
+ This means that changes to the message state, (via :meth:`add_tag`,\r
+ :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be\r
+- committed to the database until the message is :meth:`thaw`ed.\r
++ committed to the database until the message is :meth:`thaw` ed.\r
+ \r
+ Multiple calls to freeze/thaw are valid and these calls will\r
+ "stack". That is there must be as many calls to thaw as to freeze\r
+diff --git a/bindings/python/notmuch/tag.py b/bindings/python/notmuch/tag.py\r
+index f3a3d27..a77b68d 100644\r
+--- a/bindings/python/notmuch/tag.py\r
++++ b/bindings/python/notmuch/tag.py\r
+@@ -113,11 +113,12 @@ class Tags(object):\r
+ def __str__(self):\r
+ """The str() representation of Tags() is a space separated list of tags\r
+ \r
+- .. note:: As this iterates over the tags, we will not be able\r
+- to iterate over them again (as in retrieve them)! If\r
+- the tags have been exhausted already, this will raise a\r
+- :exc:`NotmuchError` STATUS.NOT_INITIALIZED on\r
+- subsequent attempts.\r
++ .. note::\r
++\r
++ As this iterates over the tags, we will not be able to iterate over\r
++ them again (as in retrieve them)! If the tags have been exhausted\r
++ already, this will raise a :exc:`NotmuchError`\r
++ STATUS.NOT_INITIALIZED on subsequent attempts.\r
+ """\r
+ return " ".join(self)\r
+ \r
+-- \r
+1.7.4.1\r
+\r
projects / notmuch-archives.git / commitdiff