Skip to content

Commit

Permalink
chore: fix docstrings for to_pandas_batches
Browse files Browse the repository at this point in the history
Co-authored-by: Gil Forsyth <[email protected]>
  • Loading branch information
cpcloud and gforsyth authored Sep 28, 2023
1 parent 0b6f637 commit 924b3d8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions ibis/backends/base/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -249,22 +249,22 @@ def to_pandas_batches(
Parameters
----------
expr
Ibis expression to execute
Ibis expression to execute.
params
Mapping of scalar parameter expressions to value.
limit
An integer to effect a specific row limit. A value of `None` means
"no limit". The default is in `ibis/config.py`.
chunk_size
Maximum number of rows in each returned record batch. This may have
Maximum number of rows in each returned `DataFrame` batch. This may have
no effect depending on the backend.
kwargs
Keyword arguments
Returns
-------
Iterator[pd.DataFrame]
An iterator pandas `DataFrame`s
An iterator of pandas `DataFrame`s.
"""
orig_expr = expr
expr = expr.as_table()
Expand Down
2 changes: 1 addition & 1 deletion ibis/expr/types/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ def to_pandas_batches(
params
Mapping of scalar parameter expressions to value.
chunk_size
Maximum number of rows in each returned batch.
Maximum number of rows in each returned `DataFrame``.
kwargs
Keyword arguments
Expand Down

0 comments on commit 924b3d8

Please sign in to comment.