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.

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

docs(python): Document aggregate_function=None in pivot #9473

Merged
merged 1 commit into from
Jun 21, 2023
Merged
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions py-polars/polars/dataframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -6379,8 +6379,14 @@ def pivot(
columns
Name of the column(s) whose values will be used as the header of the output
DataFrame.
aggregate_function : {'first', 'sum', 'max', 'min', 'mean', 'median', 'last', 'count'}
A predefined aggregate function str or an expression.
aggregate_function
Choose from:
- None: no aggregation takes place, will raise error if multiple values are in group.
- A predefined aggregate function string, one of
{'first', 'sum', 'max', 'min', 'mean', 'median', 'last', 'count'}
- An expression to do the aggregation.
maintain_order
Sort the grouped keys so that the output order is predictable.
sort_columns
Expand Down