Skip to content

Commit

Permalink
update docstring of 'list_iter()' to be more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
BurnzZ committed Oct 5, 2019
1 parent 25cd4dc commit b43d3fd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions scrapinghub/client/items.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ def _modify_iter_params(self, params):
return params

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

Expand Down

0 comments on commit b43d3fd

Please sign in to comment.