From e0b4425de181a05a600c9705a72787731bb50b57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= Date: Mon, 19 Feb 2024 13:54:29 -0600 Subject: [PATCH] Update `batch_size_rows` docs --- singer_sdk/sinks/core.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/singer_sdk/sinks/core.py b/singer_sdk/sinks/core.py index c69af0fe8..f41d3d97f 100644 --- a/singer_sdk/sinks/core.py +++ b/singer_sdk/sinks/core.py @@ -274,10 +274,10 @@ def is_full(self) -> bool: @property def batch_size_rows(self) -> int | None: - """Get batch_size_rows object. + """The maximum number of rows a batch can accumulate before being processed. Returns: - A batch_size_rows object. + The max number of rows or None if not set. """ return self._batch_size_rows @@ -290,7 +290,7 @@ def max_size(self) -> int: .. versionchanged:: 0.36.0 This property now takes into account the - :meth:`~singer_sdk.Sink.batch_size_rows` attribute and the corresponding + :attr:`~singer_sdk.Sink.batch_size_rows` attribute and the corresponding ``batch_size_rows`` target setting. """ return (