Skip to content

DOC: Update parameter descriptions in cut function for clarity #60839

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

Merged
merged 1 commit into from
Feb 3, 2025
Merged

DOC: Update parameter descriptions in cut function for clarity #60839

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
4 changes: 2 additions & 2 deletions pandas/core/reshape/tile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def cut(

Parameters
----------
x : array-like
x : 1d ndarray or Series
The input array to be binned. Must be 1-dimensional.
bins : int, sequence of scalars, or IntervalIndex
The criteria to bin by.
Expand Down Expand Up @@ -126,7 +126,7 @@ def cut(
Categorical for all other inputs. The values stored within
are whatever the type in the sequence is.

* False : returns an ndarray of integers.
* False : returns a 1d ndarray or Series of integers.

bins : numpy.ndarray or IntervalIndex.
The computed or specified bins. Only returned when `retbins=True`.
Expand Down
Loading