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

Fix indices docstrings, DataFrameGroupBy, SeriesGroupBy, Resampler #60444

Merged
merged 5 commits into from
Dec 1, 2024
Merged

Fix indices docstrings, DataFrameGroupBy, SeriesGroupBy, Resampler #60444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a87eb22
fix indices docstring error SA01
gvmmybear Nov 28, 2024
bf2fd65
correcting See Also entry for indices
gvmmybear Nov 28, 2024
c327878
correcting 'See Also' function descriptions and adding missing white …
gvmmybear Nov 29, 2024
969ceb0
Merge remote-tracking branch 'upstream/main' into fix_indices_docstrings
gvmmybear Nov 29, 2024
24ac88c
Removing unneeded verbiage in indices docstring 'See Also' section
gvmmybear Nov 29, 2024
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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
-i "pandas.core.resample.Resampler.indices SA01" \
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
-i "pandas.core.resample.Resampler.mean SA01" \
-i "pandas.core.resample.Resampler.min PR01,RT03,SA01" \
Expand Down
9 changes: 9 additions & 0 deletions pandas/core/groupby/groupby.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,15 @@ def indices(self) -> dict[Hashable, npt.NDArray[np.intp]]:
"""
Dict {group name -> group indices}.
See Also
--------
core.groupby.DataFrameGroupBy.indices : Provides a mapping of group rows to
positions of the elements.
core.groupby.SeriesGroupBy.indices : Provides a mapping of group rows to
positions of the elements.
core.resample.Resampler.indices : Provides a mapping of group rows to
positions of the elements.
Examples
--------
Expand Down
Loading