Skip to content

Commit a36c44e

Browse files
authored
DOC: Fix docstrings errors SEM and GET_GROUP (#60475)
* DOC: fix sem * Added sections * DOC: fix See also * Remove failed docstrings * Fix: Matches the right format * Pre commit format
1 parent cfd0d3f commit a36c44e

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

ci/code_checks.sh

-3
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8585
-i "pandas.arrays.NumpyExtensionArray SA01" \
8686
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
8787
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
88-
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
8988
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
90-
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
9189
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
92-
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
9390
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
9491
-i "pandas.core.resample.Resampler.mean SA01" \
9592
-i "pandas.core.resample.Resampler.min PR01,RT03,SA01" \

pandas/core/groupby/groupby.py

+13-1
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,19 @@ def get_group(self, name) -> DataFrame | Series:
715715
716716
Returns
717717
-------
718-
DataFrame or Series
718+
Series or DataFrame
719+
Get the respective Series or DataFrame corresponding to the group provided.
720+
721+
See Also
722+
--------
723+
DataFrameGroupBy.groups: Dictionary representation of the groupings formed
724+
during a groupby operation.
725+
DataFrameGroupBy.indices: Provides a mapping of group rows to positions
726+
of the elements.
727+
SeriesGroupBy.groups: Dictionary representation of the groupings formed
728+
during a groupby operation.
729+
SeriesGroupBy.indices: Provides a mapping of group rows to positions
730+
of the elements.
719731
720732
Examples
721733
--------

0 commit comments

Comments
 (0)