Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(python): Fix description of return_dtype parameter for map_elements and map_batches #14114

Merged
merged 1 commit into from
Jan 31, 2024
Merged

docs(python): Fix description of return_dtype parameter for map_elements and map_batches #14114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion py-polars/polars/expr/expr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4037,6 +4037,8 @@ def map_batches(
Lambda/function to apply.
return_dtype
Dtype of the output Series.
If not set, the dtype will be inferred based on the first non-null value
that is returned by the function.
is_elementwise
If set to true this can run in the streaming engine, but may yield
incorrect results in group-by. Ensure you know what you are doing!
Expand Down Expand Up @@ -4161,7 +4163,8 @@ def map_elements(
Lambda/function to map.
return_dtype
Dtype of the output Series.
If not set, the dtype will be `pl.Unknown`.
If not set, the dtype will be inferred based on the first non-null value
that is returned by the function.
skip_nulls
Don't map the function over values that contain nulls (this is faster).
pass_name
Expand Down
5 changes: 3 additions & 2 deletions py-polars/polars/series/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5271,8 +5271,9 @@ def map_elements(
function
Custom function or lambda.
return_dtype
Output datatype. If none is given, the same datatype as this Series will be
used.
Output datatype.
If not set, the dtype will be inferred based on the first non-null value
that is returned by the function.
skip_nulls
Nulls will be skipped and not passed to the python function.
This is faster because python can be skipped and because we call
Expand Down
Loading