Add clarifying information to completed_count documentation (#7873)

* Add clarifying information to completed_count docstring * Update canvas documentation
celery · Nov 2, 2022 · 720d192 · 720d192
1 parent be1d3c0
commit 720d192
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/celery/result.py b/celery/result.py
@@ -651,8 +651,11 @@ def ready(self):
     def completed_count(self):
         """Task completion count.
 
+        Note that `complete` means `successful` in this context. In other words, the
+        return value of this method is the number of ``successful`` tasks.
+
         Returns:
-            int: the number of tasks completed.
+            int: the number of complete (i.e. successful) tasks.
         """
         return sum(int(result.successful()) for result in self.results)
 

diff --git a/docs/userguide/canvas.rst b/docs/userguide/canvas.rst
@@ -797,7 +797,9 @@ It supports the following operations:
 
 * :meth:`~celery.result.GroupResult.completed_count`
 
-    Return the number of completed subtasks.
+    Return the number of completed subtasks. Note that `complete` means `successful` in
+    this context. In other words, the return value of this method is the number of
+    ``successful`` tasks.
 
 * :meth:`~celery.result.GroupResult.revoke`