Skip to content

DOC: Fix docstrings errors SEM and GET_GROUP #60475

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 8 commits into from
Dec 4, 2024
Merged

DOC: Fix docstrings errors SEM and GET_GROUP #60475

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
85fa90e
DOC: fix sem
Axeldnahcram Dec 2, 2024
082059c
Added sections
Axeldnahcram Dec 2, 2024
cc53d12
DOC: fix See also
Axeldnahcram Dec 2, 2024
b167840
Remove failed docstrings
Axeldnahcram Dec 2, 2024
c670853
Fix: Matches the right format
Axeldnahcram Dec 2, 2024
f731062
Pre commit format
Axeldnahcram Dec 3, 2024
5fd86ad
Merge branch 'main' into issue-60365
Axeldnahcram Dec 3, 2024
76a4492
Merge
Axeldnahcram Dec 4, 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
6 changes: 0 additions & 6 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,20 +87,14 @@ 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.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.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
-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" \
-i "pandas.core.resample.Resampler.prod SA01" \
-i "pandas.core.resample.Resampler.quantile PR01,PR07" \
-i "pandas.core.resample.Resampler.sem SA01" \
-i "pandas.core.resample.Resampler.std SA01" \
-i "pandas.core.resample.Resampler.transform PR01,RT03,SA01" \
-i "pandas.core.resample.Resampler.var SA01" \
Expand Down
19 changes: 18 additions & 1 deletion pandas/core/groupby/groupby.py
View file
Open in desktop
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 Expand Up @@ -2658,6 +2670,11 @@ def sem(self, ddof: int = 1, numeric_only: bool = False) -> NDFrameT:
Series or DataFrame
Standard error of the mean of values within each group.

See Also
--------
DataFrame.sem : Return unbiased standard error of the mean over requested axis.
Series.sem : Return unbiased standard error of the mean over requested axis.

Examples
--------
For SeriesGroupBy:
Expand Down
Loading