aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings
diff options
context:
space:
mode:
authorGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-21 00:01:23 +0100
committerGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-21 00:01:23 +0100
commit798b74e859734d12c953390bca0753f8e5e1d67c (patch)
tree3a157398f361364a43437807f4ac425eb9647496 /bindings
parenta1442952d4d7fad8b7612502802ee346ac8fd349 (diff)
python: harmonize the sphinx keyword for exceptions
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings')
-rw-r--r--bindings/python/notmuch/database.py24
-rw-r--r--bindings/python/notmuch/message.py14
-rw-r--r--bindings/python/notmuch/query.py6
-rw-r--r--bindings/python/notmuch/thread.py10
4 files changed, 27 insertions, 27 deletions
diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index 3de0f2b8..42a4442f 100644
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -140,7 +140,7 @@ class Database(object):
:param mode: Mode to open a database in. Is always
:attr:`MODE`.READ_WRITE when creating a new one.
:type mode: :attr:`MODE`
- :exception: :exc:`NotmuchError` or derived exception in case of
+ :raises: :exc:`NotmuchError` or derived exception in case of
failure.
"""
self._db = None
@@ -177,7 +177,7 @@ class Database(object):
:param path: A directory in which we should create the database.
:type path: str
:returns: Nothing
- :exception: :exc:`NotmuchError` in case of any failure
+ :raises: :exc:`NotmuchError` in case of any failure
(possibly after printing an error message on stderr).
"""
if self._db is not None:
@@ -201,7 +201,7 @@ class Database(object):
:param status: Open the database in read-only or read-write mode
:type status: :attr:`MODE`
:returns: Nothing
- :exception: Raises :exc:`NotmuchError` in case of any failure
+ :raises: Raises :exc:`NotmuchError` in case of any failure
(possibly after printing an error message on stderr).
"""
res = Database._open(_str(path), mode)
@@ -296,7 +296,7 @@ class Database(object):
neither begin nor end necessarily flush modifications to disk.
:returns: :attr:`STATUS`.SUCCESS or raises
- :exception: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION
+ :raises: :exc:`NotmuchError`: :attr:`STATUS`.XAPIAN_EXCEPTION
Xapian exception occurred; atomic section not entered.
*Added in notmuch 0.9*"""
@@ -317,7 +317,7 @@ class Database(object):
:returns: :attr:`STATUS`.SUCCESS or raises
- :exception:
+ :raises:
:exc:`NotmuchError`:
:attr:`STATUS`.XAPIAN_EXCEPTION
A Xapian exception occurred; atomic section not
@@ -346,7 +346,7 @@ class Database(object):
of database (see :meth:`get_path`), or else should be an absolute
path with initial components that match the path of 'database'.
:returns: :class:`Directory` or raises an exception.
- :exception:
+ :raises:
:exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
If path is not relative database or absolute with initial
components same as database.
@@ -410,7 +410,7 @@ class Database(object):
:rtype: 2-tuple(:class:`Message`, :attr:`STATUS`)
- :exception: Raises a :exc:`NotmuchError` with the following meaning.
+ :raises: Raises a :exc:`NotmuchError` with the following meaning.
If such an exception occurs, nothing was added to the database.
:attr:`STATUS`.FILE_ERROR
@@ -460,7 +460,7 @@ class Database(object):
This filename was removed but the message persists in the
database with at least one other filename.
- :exception: Raises a :exc:`NotmuchError` with the following meaning.
+ :raises: Raises a :exc:`NotmuchError` with the following meaning.
If such an exception occurs, nothing was removed from the
database.
@@ -479,7 +479,7 @@ class Database(object):
:param msgid: The message ID
:type msgid: unicode or str
:returns: :class:`Message` or `None` if no message is found.
- :exception:
+ :raises:
:exc:`OutOfMemoryError`
If an Out-of-memory occured while constructing the message.
:exc:`XapianError`
@@ -512,7 +512,7 @@ class Database(object):
function returns None if no message is found with the given
filename.
- :exception:
+ :raises:
:exc:`OutOfMemoryError`
If an Out-of-memory occured while constructing the message.
:exc:`XapianError`
@@ -681,7 +681,7 @@ class Directory(object):
:param mtime: A (time_t) timestamp
:returns: Nothing on success, raising an exception on failure.
- :exception: :exc:`NotmuchError`:
+ :raises: :exc:`NotmuchError`:
:attr:`STATUS`.XAPIAN_EXCEPTION
A Xapian exception occurred, mtime not stored.
@@ -708,7 +708,7 @@ class Directory(object):
:param mtime: A (time_t) timestamp
:returns: Nothing on success, raising an exception on failure.
- :exception: :exc:`NotmuchError`:
+ :raises: :exc:`NotmuchError`:
:attr:`STATUS`.NOT_INITIALIZED
The directory has not been initialized
diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py
index b291f9fa..ce7cb885 100644
--- a/bindings/python/notmuch/message.py
+++ b/bindings/python/notmuch/message.py
@@ -370,7 +370,7 @@ class Message(Python3StringMixIn):
"""Returns the message ID
:returns: String with a message ID
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -387,7 +387,7 @@ class Message(Python3StringMixIn):
message belongs to a single thread.
:returns: String with a thread ID
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -410,7 +410,7 @@ class Message(Python3StringMixIn):
an empty Messages iterator.
:returns: :class:`Messages`.
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -432,7 +432,7 @@ class Message(Python3StringMixIn):
:returns: A time_t timestamp.
:rtype: c_unit64
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -469,7 +469,7 @@ class Message(Python3StringMixIn):
"""Returns the file path of the message file
:returns: Absolute file path & name of the message file
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -499,7 +499,7 @@ class Message(Python3StringMixIn):
:param flag: One of the :attr:`Message.FLAG` values (currently only
*Message.FLAG.MATCH*
:returns: An unsigned int (0/1), indicating whether the flag is set.
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
@@ -514,7 +514,7 @@ class Message(Python3StringMixIn):
:param value: A bool indicating whether to set or unset the flag.
:returns: Nothing
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._msg:
diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py
index 6132ca00..25b9e780 100644
--- a/bindings/python/notmuch/query.py
+++ b/bindings/python/notmuch/query.py
@@ -89,7 +89,7 @@ class Query(object):
:param querystr: The query string
:type querystr: utf-8 encoded str or unicode
:returns: Nothing
- :exception:
+ :raises:
:exc:`NullPointerError` if the query creation failed
(e.g. too little memory).
:exc:`NotInitializedError` if the underlying db was not
@@ -134,7 +134,7 @@ class Query(object):
to get the value of this flag.
:returns: :class:`Threads`
- :exception: :exc:`NullPointerError` if search_threads failed
+ :raises: :exc:`NullPointerError` if search_threads failed
"""
self._assert_query_is_initialized()
threads_p = Query._search_threads(self._query)
@@ -153,7 +153,7 @@ class Query(object):
:class:`Messages` in the defined sort order
:returns: :class:`Messages`
- :exception: :exc:`NullPointerError` if search_messages failed
+ :raises: :exc:`NullPointerError` if search_messages failed
"""
self._assert_query_is_initialized()
msgs_p = Query._search_messages(self._query)
diff --git a/bindings/python/notmuch/thread.py b/bindings/python/notmuch/thread.py
index 5c580288..d1ba3e55 100644
--- a/bindings/python/notmuch/thread.py
+++ b/bindings/python/notmuch/thread.py
@@ -248,7 +248,7 @@ class Thread(object):
for as long as the thread is valid.
:returns: String with a message ID
- :exception: :exc:`NotInitializedError` if the thread
+ :raises: :exc:`NotInitializedError` if the thread
is not initialized.
"""
if not self._thread:
@@ -265,7 +265,7 @@ class Thread(object):
:returns: The number of all messages in the database
belonging to this thread. Contrast with
:meth:`get_matched_messages`.
- :exception: :exc:`NotInitializedError` if the thread
+ :raises: :exc:`NotInitializedError` if the thread
is not initialized.
"""
if not self._thread:
@@ -309,7 +309,7 @@ class Thread(object):
:returns: The number of all messages belonging to this thread that
matched the :class:`Query`from which this thread was created.
Contrast with :meth:`get_total_messages`.
- :exception: :exc:`NotInitializedError` if the thread
+ :raises: :exc:`NotInitializedError` if the thread
is not initialized.
"""
if not self._thread:
@@ -351,7 +351,7 @@ class Thread(object):
:returns: A time_t timestamp.
:rtype: c_unit64
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._thread:
@@ -363,7 +363,7 @@ class Thread(object):
:returns: A time_t timestamp.
:rtype: c_unit64
- :exception: :exc:`NotInitializedError` if the message
+ :raises: :exc:`NotInitializedError` if the message
is not initialized.
"""
if not self._thread: