aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/messages.rst
diff options
context:
space:
mode:
authorJustus Winter <4winter@informatik.uni-hamburg.de>2012-02-24 01:34:15 +0100
committerJustus Winter <4winter@informatik.uni-hamburg.de>2012-02-24 01:55:33 +0100
commitd50171d1cc575a41bf620c55853ade65d0edfad8 (patch)
tree495247d3b0f2ec1af08211330e6a9e8f8b428c7f /bindings/python/docs/source/messages.rst
parent594dbb62432bd7f92d1e121145b80628eb8aad2a (diff)
python: split the documentation
Move each classes documentation into its own file and thus into its own page in the generated documentation. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings/python/docs/source/messages.rst')
-rw-r--r--bindings/python/docs/source/messages.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/bindings/python/docs/source/messages.rst b/bindings/python/docs/source/messages.rst
new file mode 100644
index 0000000..3ccf505
--- /dev/null
+++ b/bindings/python/docs/source/messages.rst
@@ -0,0 +1,15 @@
+:class:`Messages` -- A bunch of messages
+========================================
+
+.. currentmodule:: notmuch
+
+.. autoclass:: Messages
+
+ .. automethod:: collect_tags
+
+ .. method:: __len__()
+
+ .. 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))`.