Skip to content

Commit

Permalink
DOC: Fix docstrings errors SEM and GET_GROUP (#60475)
Browse files Browse the repository at this point in the history
* DOC: fix sem

* Added sections

* DOC: fix See also

* Remove failed docstrings

* Fix: Matches the right format

* Pre commit format
  • Loading branch information
Axeldnahcram authored Dec 4, 2024
1 parent cfd0d3f commit a36c44e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
3 changes: 0 additions & 3 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.arrays.NumpyExtensionArray SA01" \
-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.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.resample.Resampler.get_group RT03,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
14 changes: 13 additions & 1 deletion pandas/core/groupby/groupby.py
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,19 @@ def get_group(self, name) -> DataFrame | Series:
Returns
-------
DataFrame or Series
Series or DataFrame
Get the respective Series or DataFrame corresponding to the group provided.
See Also
--------
DataFrameGroupBy.groups: Dictionary representation of the groupings formed
during a groupby operation.
DataFrameGroupBy.indices: Provides a mapping of group rows to positions
of the elements.
SeriesGroupBy.groups: Dictionary representation of the groupings formed
during a groupby operation.
SeriesGroupBy.indices: Provides a mapping of group rows to positions
of the elements.
Examples
--------
Expand Down

0 comments on commit a36c44e

Please sign in to comment.