Skip to content

Commit 6526829

Browse files
authored
DOC: indices docstrings for DataFrameGroupBy, SeriesGroupBy, Resampler (#60444)
1 parent a4fc97e commit 6526829

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

ci/code_checks.sh

-3
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8989
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
9090
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
9191
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
92-
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
9392
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
9493
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
9594
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
9695
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
97-
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
9896
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
9997
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
10098
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
101-
-i "pandas.core.resample.Resampler.indices SA01" \
10299
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
103100
-i "pandas.core.resample.Resampler.mean SA01" \
104101
-i "pandas.core.resample.Resampler.min PR01,RT03,SA01" \

pandas/core/groupby/groupby.py

+9
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,15 @@ def indices(self) -> dict[Hashable, npt.NDArray[np.intp]]:
515515
"""
516516
Dict {group name -> group indices}.
517517
518+
See Also
519+
--------
520+
core.groupby.DataFrameGroupBy.indices : Provides a mapping of group rows to
521+
positions of the elements.
522+
core.groupby.SeriesGroupBy.indices : Provides a mapping of group rows to
523+
positions of the elements.
524+
core.resample.Resampler.indices : Provides a mapping of group rows to
525+
positions of the elements.
526+
518527
Examples
519528
--------
520529

0 commit comments

Comments
 (0)