[PATCH 1/3] python/notmuch2: correct docstring for Database.count_messages()

Subject: [PATCH 1/3] python/notmuch2: correct docstring for Database.count_messages()

Date: Wed, 6 Jan 2021 10:08:40 +0100

To: notmuch@notmuchmail.org

Cc:

From: Michael J Gruber

Signed-off-by: Michael J Gruber <git@grubix.eu>
---
 bindings/python-cffi/notmuch2/_database.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/bindings/python-cffi/notmuch2/_database.py b/bindings/python-cffi/notmuch2/_database.py
index 868f4408..31b282f6 100644
--- a/bindings/python-cffi/notmuch2/_database.py
+++ b/bindings/python-cffi/notmuch2/_database.py
@@ -605,10 +605,10 @@ class Database(base.NotmuchObject):
                        omit_excluded=EXCLUDE.TRUE,
                        sort=SORT.UNSORTED,  # Check this default
                        exclude_tags=None):
-        """Search the database for messages.
+        """Search the database for messages and count.
 
-        :returns: An iterator over the messages found.
-        :rtype: MessageIter
+        :returns: The number of messages found.
+        :rtype: int
 
         :raises ObjectDestroyedError: if used after destroyed.
         """
-- 
2.30.0.rc0.297.gbcca948854
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: