python: improve the docstring of Database.find_message_by_filename

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2012-02-22 21:07:18 +01:00
parent fcf19ad029
commit 05cdb3d7b7

View file

@ -515,17 +515,16 @@ class Database(object):
function returns None if no message is found with the given function returns None if no message is found with the given
filename. filename.
:raises: :raises: :exc:`OutOfMemoryError` if an Out-of-memory occured while
:exc:`OutOfMemoryError` constructing the message.
If an Out-of-memory occured while constructing the message. :raises: :exc:`XapianError` in case of a Xapian Exception.
:exc:`XapianError` These exceptions include "Database modified"
In case of a Xapian Exception. These exceptions situations, e.g. when the notmuch database has been
include "Database modified" situations, e.g. when the modified by another program in the meantime. In this
notmuch database has been modified by another program case, you should close and reopen the database and
in the meantime. In this case, you should close and retry.
reopen the database and retry. :raises: :exc:`NotInitializedError` if the database was not
:exc:`NotInitializedError` if intitialized.
the database was not intitialized.
*Added in notmuch 0.9*""" *Added in notmuch 0.9*"""
self._assert_db_is_initialized() self._assert_db_is_initialized()