diff options
| author |  Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-09-29 11:00:43 +0200 |
|---|---|---|
| committer | Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-09-29 11:00:43 +0200 |
| commit | f63d605835bf7a5f05f6cf0f201f1e14e051179c (patch) | |
| tree | 1c484edd7e2f0f5d28ded1591a69353cdcf1e1e3 /bindings | |
| parent | eb4cd33e6b5406bf69273be52f88a57dad6e8126 (diff) | |
python: Add new functions in API documentation
Add documentation for the three new functions and add in which version
they have been added.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Diffstat (limited to 'bindings')
| -rw-r--r-- | bindings/python/docs/source/index.rst | 6 | ||||
| -rw-r--r-- | bindings/python/notmuch/database.py | 15 |
2 files changed, 16 insertions, 5 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index d26a0501..012bef50 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -55,6 +55,10 @@ More information on specific topics can be found on the following pages: .. automethod:: upgrade + .. automethod:: begin_atomic + + .. automethod:: end_atomic + .. automethod:: get_directory .. automethod:: add_message @@ -63,6 +67,8 @@ More information on specific topics can be found on the following pages: .. automethod:: find_message + .. automethod:: find_message_by_filename + .. automethod:: get_all_tags .. automethod:: create_query diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py index c29ca6ee..1e6d3375 100644 --- a/bindings/python/notmuch/database.py +++ b/bindings/python/notmuch/database.py @@ -224,10 +224,11 @@ class Database(object): :returns: :attr:`STATUS`.SUCCESS or raises - :exception: :exc:`NotmuchError` :attr:`STATUS`.XAPIAN_EXCEPTION:: + :exception: :exc:`NotmuchError`: + :attr:`STATUS`.XAPIAN_EXCEPTION + Xapian exception occurred; atomic section not entered. - A Xapian exception occurred; atomic section not - entered.""" + *Added in notmuch 0.9*""" self._assert_db_is_initialized() status = nmlib.notmuch_database_begin_atomic(self._db) if status != STATUS.SUCCESS: @@ -247,7 +248,9 @@ class Database(object): A Xapian exception occurred; atomic section not ended. :attr:`STATUS`.UNBALANCED_ATOMIC: - end_atomic has been called more times than begin_atomic.""" + end_atomic has been called more times than begin_atomic. + + *Added in notmuch 0.9*""" self._assert_db_is_initialized() status = nmlib.notmuch_database_end_atomic(self._db) if status != STATUS.SUCCESS: @@ -431,7 +434,9 @@ class Database(object): * No message is found with the given filename * An out-of-memory situation occurs - * A Xapian exception occurs""" + * A Xapian exception occurs + + *Added in notmuch 0.9*""" self._assert_db_is_initialized() msg_p = Database._find_message_by_filename(self._db, _str(filename)) return msg_p and Message(msg_p, self) or None |