From bf6039e34eca52ccf7fe1db51e1b5c843a9828f3 Mon Sep 17 00:00:00 2001 From: Justus Winter <4winter@informatik.uni-hamburg.de> Date: Sat, 18 Feb 2012 01:38:19 +0100 Subject: [PATCH] python: improve Query.count_messages docstring Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de> --- bindings/python/notmuch/query.py | 15 +++++---------- 1 file 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)