From: Justus Winter <4winter@informatik.uni-hamburg.de>
Date: Mon, 30 Apr 2012 16:43:02 +0000 (+0200)
Subject: python: update the docstrings of Filenames.{__len__,__unicode}
X-Git-Tag: 0.13_rc1~31
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=09fdf2b283938da1cded87ec8621aabe917a8fa5;p=notmuch.git

python: update the docstrings of Filenames.{__len__,__unicode}

Formerly the documentation was overly verbose. Reword the comment and
use the same for both functions.

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
---

diff --git a/bindings/python/notmuch/filenames.py b/bindings/python/notmuch/filenames.py
index 830618bf..d201ae22 100644
--- a/bindings/python/notmuch/filenames.py
+++ b/bindings/python/notmuch/filenames.py
@@ -115,13 +115,10 @@ class Filenames(Python3StringMixIn):
     def __unicode__(self):
         """Represent Filenames() as newline-separated list of full paths
 
-        .. note:: As this iterates over the filenames, we will not be
-               able to iterate over them again (as in retrieve them)! If
-               the tags have been exhausted already, this will raise a
-               :exc:`NotInitializedError` on subsequent
-               attempts. However, you can use
-               :meth:`Message.get_filenames` repeatedly to perform
-               various actions on filenames.
+        .. note::
+
+            This method exhausts the iterator object, so you will not be able to
+            iterate over them again.
         """
         return "\n".join(self)
 
@@ -139,15 +136,8 @@ class Filenames(Python3StringMixIn):
 
         .. note::
 
-            As this iterates over the files, we will not be able to
-            iterate over them again! So this will fail::
-
-                 #THIS FAILS
-                 files = Database().get_directory('').get_child_files()
-                 if len(files) > 0:  # this 'exhausts' msgs
-                     # next line raises
-                     # NotmuchError(:attr:`STATUS`.NOT_INITIALIZED)
-                     for file in files: print file
+            This method exhausts the iterator object, so you will not be able to
+            iterate over them again.
         """
         if not self._files_p:
             raise NotInitializedError()