From d5fa232266b1cca1267849a5592a66c795282f43 Mon Sep 17 00:00:00 2001 From: SergioSim Date: Fri, 8 Dec 2023 09:36:40 +0100 Subject: [PATCH] fixup! update prefetch docstring --- src/ralph/backends/data/async_es.py | 3 ++- src/ralph/backends/data/async_mongo.py | 3 ++- src/ralph/backends/data/base.py | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/ralph/backends/data/async_es.py b/src/ralph/backends/data/async_es.py index 79fe9b75f..8acdc66ad 100644 --- a/src/ralph/backends/data/async_es.py +++ b/src/ralph/backends/data/async_es.py @@ -132,7 +132,8 @@ async def read( # noqa: PLR0913 ignore_errors (bool): No impact as encoding errors are not expected in Elasticsearch results. prefetch (int): The number of records to prefetch (queue) while yielding. - If `prefetch` is `None` it defaults to `1` - no records are prefetched. + If `prefetch` is `None` it defaults to `1`, i.e. no records are + prefetched. max_statements (int): The maximum number of statements to yield. If `None` (default) or `0`, there is no maximum. diff --git a/src/ralph/backends/data/async_mongo.py b/src/ralph/backends/data/async_mongo.py index 529c58756..08410c426 100644 --- a/src/ralph/backends/data/async_mongo.py +++ b/src/ralph/backends/data/async_mongo.py @@ -139,7 +139,8 @@ async def read( # noqa: PLR0913 will be ignored and logged. If `False` (default), a `BackendException` is raised on any error. prefetch (int): The number of records to prefetch (queue) while yielding. - If `prefetch` is `None` it defaults to `1` - no records are prefetched. + If `prefetch` is `None` it defaults to `1`, i.e. no records are + prefetched. max_statements (int): The maximum number of statements to yield. If `None` (default) or `0`, there is no maximum. diff --git a/src/ralph/backends/data/base.py b/src/ralph/backends/data/base.py index 03b100818..eedcf6e82 100644 --- a/src/ralph/backends/data/base.py +++ b/src/ralph/backends/data/base.py @@ -530,7 +530,8 @@ async def read( # noqa: PLR0913 will be ignored and logged. If `False` (default), a `BackendException` is raised on any error. prefetch (int): The number of records to prefetch (queue) while yielding. - If `prefetch` is `None` it defaults to `1` - no records are prefetched. + If `prefetch` is `None` it defaults to `1`, i.e. no records are + prefetched. max_statements (int): The maximum number of statements to yield. If `None` (default) or `0`, there is no maximum.