fixup! update prefetch docstring

openfun · Dec 8, 2023 · d5fa232 · d5fa232
1 parent 6956c70
commit d5fa232
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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.