diff options
| author | Sebastian Spaeth <sebastian@sspaeth.de> | 2010-03-17 15:14:44 +0100 |
|---|---|---|
| committer | Sebastian Spaeth <sebastian@sspaeth.de> | 2010-03-17 15:14:44 +0100 |
| commit | d2b4307851f184908bd8aa2217eb1a31f66f7cc7 (patch) | |
| tree | d23cd4cb28fe098a0366af59f22de5d04d743972 /docs/source | |
| parent | 61bef71a126efb02b477209a02789cc194a5b784 (diff) | |
docs: doc improvements
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/index.rst | 35 |
1 files changed, 28 insertions, 7 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index d6f9411d..a3bc2654 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -62,17 +62,38 @@ or:: .. autoattribute:: db_p -:class:`Query` -- Represents a notmuch Query +:class:`Query` -- A search query ----------------------------------------------- .. autoclass:: Query - :members: + + .. automethod:: create + + .. attribute:: Query.SORT + + Defines constants that are used as the mode in which to open a database. + + SORT.OLDEST_FIRST + Sort by message date, oldest first. + + SORT.NEWEST_FIRST + Sort by message date, newest first. + + SORT.MESSAGE_ID + Sort by email message ID + + .. automethod:: set_sort + + .. automethod:: search_messages :class:`Messages` -- A bunch of messages ---------------------------------------- .. autoclass:: Messages - :members: + + .. automethod:: collect_tags + + .. automethod:: __len__ :class:`Message` -- A single message ---------------------------------------- @@ -80,15 +101,15 @@ or:: .. autoclass:: Message :members: -:class:`Tags` -- A bunch of notmuch tags ----------------------------------------- +:class:`Tags` -- Notmuch tags +----------------------------- .. autoclass:: Tags :members: - .. data: '__notmuchcmd__' + .. automethod:: __len__ - This is the actual binary that will be executed in order to run a notmuch command. This is set to *notmuch* and should usually not be changed. + .. automethod:: __str__ :exc:`NotmuchError` -- A Notmuch execution error ------------------------------------------------ |
