mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-26 12:55:18 +01:00
0817f0e168
Various API doc cleanups and improvements. No code change. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
23 lines
765 B
ReStructuredText
23 lines
765 B
ReStructuredText
.. currentmodule:: notmuch
|
|
|
|
Status and Errors
|
|
=================
|
|
|
|
Some methods return a status, indicating if an operation was successful and what the error was. Most of these status codes are expressed as a specific value, the :class:`notmuch.STATUS`.
|
|
|
|
:class:`STATUS` -- Notmuch operation return value
|
|
--------------------------------------------------
|
|
|
|
.. autoclass:: notmuch.STATUS
|
|
:inherited-members:
|
|
|
|
.. automethod:: notmuch.STATUS.status2str
|
|
|
|
:exc:`NotmuchError` -- A Notmuch execution error
|
|
------------------------------------------------
|
|
Whenever an error occurs, we throw a special Exception:
|
|
|
|
.. autoexception:: NotmuchError
|
|
:members:
|
|
|
|
This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
|