debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2025-01-18 09:15:56 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: Add new functions in API documentation

Browse source 
Add documentation for the three new functions and add in which version
they have been added.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
This commit is contained in:
Sebastian Spaeth 2011-09-29 11:00:43 +02:00
parent eb4cd33e6b
commit f63d605835
2 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
bindings/python/docs/source/index.rst
View file

@ -55,6 +55,10 @@ More information on specific topics can be found on the following pages:
.. automethod:: upgrade .. automethod:: upgrade
.. automethod:: begin_atomic
.. automethod:: end_atomic
.. automethod:: get_directory .. automethod:: get_directory
.. automethod:: add_message .. 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
.. automethod:: find_message_by_filename
.. automethod:: get_all_tags .. automethod:: get_all_tags
.. automethod:: create_query .. automethod:: create_query

15
bindings/python/notmuch/database.py
View file

@ -224,10 +224,11 @@ class Database(object):
:returns: :attr:`STATUS`.SUCCESS or raises :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 *Added in notmuch 0.9*"""
entered."""
self._assert_db_is_initialized() self._assert_db_is_initialized()
status = nmlib.notmuch_database_begin_atomic(self._db) status = nmlib.notmuch_database_begin_atomic(self._db)
if status != STATUS.SUCCESS: if status != STATUS.SUCCESS:
@ -247,7 +248,9 @@ class Database(object):
A Xapian exception occurred; atomic section not A Xapian exception occurred; atomic section not
ended. ended.
:attr:`STATUS`.UNBALANCED_ATOMIC: :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() self._assert_db_is_initialized()
status = nmlib.notmuch_database_end_atomic(self._db) status = nmlib.notmuch_database_end_atomic(self._db)
if status != STATUS.SUCCESS: if status != STATUS.SUCCESS:
@ -431,7 +434,9 @@ class Database(object):
* No message is found with the given filename * No message is found with the given filename
* An out-of-memory situation occurs * An out-of-memory situation occurs
* A Xapian exception occurs""" * A Xapian exception occurs
*Added in notmuch 0.9*"""
self._assert_db_is_initialized() self._assert_db_is_initialized()
msg_p = Database._find_message_by_filename(self._db, _str(filename)) msg_p = Database._find_message_by_filename(self._db, _str(filename))
return msg_p and Message(msg_p, self) or None return msg_p and Message(msg_p, self) or None