Rectified docstring

0phoff · Jul 1, 2024 · a8c403b · a8c403b
1 parent 40a61f9
commit a8c403b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/striker/mixins/loop_test.py b/striker/mixins/loop_test.py
@@ -55,6 +55,9 @@ def batch_begin(self: Any, batch: int) -> None:
 
         Args:
             batch: Number of the batch we start.
+
+        Note:
+            The ``batch`` argument is equal to ``self.batch + 1``, as the ``self.batch`` variable shows the number of completed batches.
         """
 
     def batch_end(self: Any, batch: int, output: Any) -> None: