Skip to content

Commit 4919674

Browse files
DOC: fix RT03,SA01,ES01 for pandas.core.resample.Resampler.__iter__
1 parent 2a10e04 commit 4919674

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
117117
-i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \
118118
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
119119
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
120-
-i "pandas.core.resample.Resampler.__iter__ RT03,SA01" \
121120
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
122121
-i "pandas.core.resample.Resampler.groups SA01" \
123122
-i "pandas.core.resample.Resampler.indices SA01" \

pandas/core/groupby/groupby.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -767,10 +767,23 @@ def __iter__(self) -> Iterator[tuple[Hashable, NDFrameT]]:
767767
"""
768768
Groupby iterator.
769769
770+
This method provides an iterator over the groups created by the resampling
771+
operation on the object. The method yields tuples where the first element
772+
is the label (group key) corresponding to each resampled bin, and the second
773+
element is the subset of the data that falls within that bin.
774+
770775
Returns
771776
-------
772-
Generator yielding sequence of (name, subsetted object)
773-
for each group
777+
Iterator
778+
Generator yielding a sequence of (name, subsetted object)
779+
for each resampled group.
780+
781+
See Also
782+
--------
783+
Series.groupby : Group data by a specific key or column.
784+
DataFrame.groupby : Group DataFrame using mapper or by columns.
785+
DataFrame.resample : Resample a DataFrame.
786+
Series.resample : Resample a Series.
774787
775788
Examples
776789
--------

0 commit comments

Comments
 (0)