docstring

Textualize · Feb 11, 2024 · f0042a1 · f0042a1
1 parent 51d0d62
commit f0042a1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/toolong/log_file.py b/src/toolong/log_file.py
@@ -139,6 +139,14 @@ def read(self, size: int) -> bytes:
     def scan_line_breaks(
         self, batch_time: float = 0.25
     ) -> Iterable[tuple[int, list[int]]]:
+        """Scan the file for line breaks.
+
+        Args:
+            batch_time: Time to group the batches.
+
+        Returns:
+            An iterable of tuples, containing the scan position and a list of offsets of new lines.
+        """
         fileno = self.fileno
         size = self.size
         if not size: