Skip to content

Commit 649f8c1

Browse files
committed
clarify linger=0 behavior
1 parent 56b60ae commit 649f8c1

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/s2_sdk/_types.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,11 @@ class Batching:
208208
"""Maximum metered bytes per batch. Must be between 8 and 1 MiB. Default is 1 MiB."""
209209

210210
linger: timedelta = field(default_factory=lambda: timedelta(milliseconds=5))
211-
"""Maximum time to wait for more records before flushing a partial batch. Default is 5 ms."""
211+
"""Maximum time to wait for more records before flushing a partial batch. Default is 5 ms.
212+
213+
Note:
214+
If set to 0, batches are flushed only when ``max_records`` or ``max_bytes`` is reached.
215+
"""
212216

213217

214218
@dataclass(slots=True)

0 commit comments

Comments
 (0)