dev(narugo): add max count docs

deepghs · Sep 23, 2024 · 0a0a931 · 0a0a931
1 parent 86bd537
commit 0a0a931
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/cheesechaser/pipe/base.py b/cheesechaser/pipe/base.py
@@ -110,6 +110,11 @@ def next(self, block: bool = True, timeout: Optional[float] = None) -> PipeItem:
         return self.queue.get(block=block, timeout=timeout)
 
     def _count_update(self, n: int = 1):
+        """
+        Update current count. If the count reaches the limit, set the status to ``stopped``.
+
+        :param n: Count for Adding. Default is 1.
+        """
         self._current_count += n
         if self.max_count is not None and self._current_count >= self.max_count:
             self.is_stopped.set()