X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=bindings%2Fpython%2Fdocs%2Fsource%2Findex.rst;h=f7d3d6058e3b058a171da31a365d57b2b02abd0f;hb=8c5be7d12dc5e48faf4008209327d34c04961616;hp=e9f39eb03428269bf037b1255095dc885d29d162;hpb=0817f0e168c8212200fc6624aeaac77318a9bc35;p=notmuch diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index e9f39eb0..f7d3d605 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -21,7 +21,13 @@ Notmuch can be imported as:: or:: - from notmuch import Query,Database + from notmuch import Query, Database + + db = Database('path',create=True) + msgs = Query(db,'from:myself').search_messages() + + for msg in msgs: + print (msg) More information on specific topics can be found on the following pages: @@ -36,8 +42,6 @@ More information on specific topics can be found on the following pages: .. automodule:: notmuch -:todo: Document nmlib,STATUS - :class:`notmuch.Database` -- The underlying notmuch database --------------------------------------------------------------------- @@ -55,6 +59,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,13 +71,12 @@ 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 - .. note:: :meth:`create_query` was broken in release - 0.1 and is fixed since 0.1.1. - .. attribute:: Database.MODE Defines constants that are used as the mode in which to open a database. @@ -82,6 +89,7 @@ More information on specific topics can be found on the following pages: .. autoattribute:: db_p + :class:`notmuch.Query` -- A search query ------------------------------------------------- @@ -130,10 +138,10 @@ More information on specific topics can be found on the following pages: .. method:: __len__() - .. note:: :meth:`__len__` was removed in version 0.6 as it exhausted - the iterator and broke list(Messages()). Use the - :meth:`Query.count_messages` function or use - `len(list(msgs))`. + .. warning:: + + :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke + list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`. :class:`Message` -- A single message ---------------------------------------- @@ -195,7 +203,13 @@ More information on specific topics can be found on the following pages: .. autoclass:: Tags :members: - .. automethod:: __len__ + .. method:: __len__ + + .. warning:: + + :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke + list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of + tags. .. automethod:: __str__