Skip to content

Commit 62cab36

Browse files
committed
update docstring of 'list_iter()' to be more clear
1 parent 25cd4dc commit 62cab36

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

scrapinghub/client/items.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ def _modify_iter_params(self, params):
6161
return params
6262

6363
def list_iter(self, chunksize=10000, *args, **kwargs):
64-
"""An alternative for reading and processing items by returning a
65-
generator of item chunks.
64+
"""An alternative interface for reading items by returning them
65+
as a generator which yields lists of items sized as `chunksize`.
6666
6767
This is a convenient method for cases when processing a large amount of
6868
items from a job isn't ideal in one go due to the large memory needed.
@@ -71,7 +71,7 @@ def list_iter(self, chunksize=10000, *args, **kwargs):
7171
You can improve I/O overheads by increasing the chunk value but that
7272
would also increase the memory consumption.
7373
74-
:return: an iterator over a list of elements.
74+
:return: an iterator over items, yielding lists of items.
7575
:rtype: :class:`collections.Iterable`
7676
"""
7777

0 commit comments

Comments
 (0)