diff options
author | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-04-30 18:43:02 +0200 |
---|---|---|
committer | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-04-30 18:43:02 +0200 |
commit | 09fdf2b283938da1cded87ec8621aabe917a8fa5 (patch) | |
tree | 99ef304aed2e5e53df0ac71c1e8bb3fcf4b40846 /bindings | |
parent | 0803603cdd0d2db0a0b073aba1ffd79077acba84 (diff) |
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>
Diffstat (limited to 'bindings')
-rw-r--r-- | bindings/python/notmuch/filenames.py | 22 |
1 files changed, 6 insertions, 16 deletions
diff --git a/bindings/python/notmuch/filenames.py b/bindings/python/notmuch/filenames.py index 830618b..d201ae2 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() |