debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 09:24:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
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>
This commit is contained in:
Justus Winter 2012-04-30 18:43:02 +02:00
parent 0803603cdd
commit 09fdf2b283
1 changed files with 6 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
bindings/python/notmuch/filenames.py
View file

@ -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()