aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings
diff options
context:
space:
mode:
authorGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-22 21:07:18 +0100
committerGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-22 21:14:35 +0100
commit05cdb3d7b7c007364fe9fa38ff36488feaf698b7 (patch)
tree4c8c8da541e796b389f20c5e912ceb68522d4eb4 /bindings
parentfcf19ad029913e88558a21135feb0b5e1b33cef3 (diff)
python: improve the docstring of Database.find_message_by_filename
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings')
-rw-r--r--bindings/python/notmuch/database.py21
1 files changed, 10 insertions, 11 deletions
diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index 82cb803a..ebb8f209 100644
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -515,17 +515,16 @@ class Database(object):
function returns None if no message is found with the given
filename.
- :raises:
- :exc:`OutOfMemoryError`
- If an Out-of-memory occured while constructing the message.
- :exc:`XapianError`
- In case of a Xapian Exception. These exceptions
- include "Database modified" situations, e.g. when the
- notmuch database has been modified by another program
- in the meantime. In this case, you should close and
- reopen the database and retry.
- :exc:`NotInitializedError` if
- the database was not intitialized.
+ :raises: :exc:`OutOfMemoryError` if an Out-of-memory occured while
+ constructing the message.
+ :raises: :exc:`XapianError` in case of a Xapian Exception.
+ These exceptions include "Database modified"
+ situations, e.g. when the notmuch database has been
+ modified by another program in the meantime. In this
+ case, you should close and reopen the database and
+ retry.
+ :raises: :exc:`NotInitializedError` if the database was not
+ intitialized.
*Added in notmuch 0.9*"""
self._assert_db_is_initialized()