aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings
diff options
context:
space:
mode:
authorGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-18 01:38:19 +0100
committerGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-02-18 01:39:39 +0100
commitbf6039e34eca52ccf7fe1db51e1b5c843a9828f3 (patch)
tree1634b7420dff3c222b102390e62400d45851d4ce /bindings
parentff8f864245c3ac54cc23aa47af09c95cde484abb (diff)
python: improve Query.count_messages docstring
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings')
-rw-r--r--bindings/python/notmuch/query.py15
1 files changed, 5 insertions, 10 deletions
diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py
index 14c00cd5..0c08aa9e 100644
--- a/bindings/python/notmuch/query.py
+++ b/bindings/python/notmuch/query.py
@@ -162,23 +162,18 @@ class Query(object):
raise NullPointerError
return Messages(msgs_p, self)
- """notmuch_query_count_messages"""
_count_messages = nmlib.notmuch_query_count_messages
_count_messages.argtypes = [NotmuchQueryP]
_count_messages.restype = c_uint
def count_messages(self):
- """Estimate the number of messages matching the query
-
+ '''
This function performs a search and returns Xapian's best
- guess as to the number of matching messages. It is much faster
- than performing :meth:`search_messages` and counting the
- result with `len()` (although it always returned the same
- result in my tests). Technically, it wraps the underlying
- *notmuch_query_count_messages* function.
+ guess as to the number of matching messages.
- :returns: :class:`Messages`
- """
+ :returns: the estimated number of messages matching this query
+ :rtype: int
+ '''
self._assert_query_is_initialized()
return Query._count_messages(self._query)