diff options
| author |  Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-10-05 17:54:09 +0200 |
|---|---|---|
| committer | Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-10-05 17:54:09 +0200 |
| commit | 42f184c23668173e675a006864f188155826d1bd (patch) | |
| tree | 98b7f2c813eb05b8887e4ba75f840a5dc4d7db84 /bindings/python/docs | |
| parent | a8db280f586963c82499d7a797fb15d2f766976f (diff) | |
python: clean up docstrings and API documentation
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Diffstat (limited to 'bindings/python/docs')
| -rw-r--r-- | bindings/python/docs/source/index.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index 012bef50..73d2a3b0 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 --------------------------------------------------------------------- @@ -73,9 +77,6 @@ More information on specific topics can be found on the following pages: .. 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. @@ -88,6 +89,7 @@ More information on specific topics can be found on the following pages: .. autoattribute:: db_p + :class:`notmuch.Query` -- A search query ------------------------------------------------- |