Skip to content

Commit 0044725

Browse files
committed
add docs
1 parent 1ee77c7 commit 0044725

File tree

4 files changed

+18
-4
lines changed

4 files changed

+18
-4
lines changed

pandas/core/groupby/base.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""
2-
base components for groupby
2+
Provide basic components for groupby. These defintiions
3+
hold the whitelist of methods that are exposed on the
4+
SeriesGroupBy and the DataFrameGroupBy objects.
35
"""
46

57
import types

pandas/core/groupby/generic.py

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
"""
22
Define the SeriesGroupBy, DataFrameGroupBy, and PanelGroupBy
33
classes that hold the groupby interfaces (and some implementations).
4+
45
These are user facing as the result of the ``df.groupby(...)`` operations,
56
which here returns a DataFrameGroupBy object.
67
"""

pandas/core/groupby/groupby.py

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
"""
2+
Provide the groupby split-apply-combine paradigm. Define the GroupBy
3+
class providing the base-class of operations.
4+
5+
The SeriesGroupBy and DataFrameGroupBy sub-class
6+
(defined in pandas.core.groupby.generic)
7+
expose these user-facing objects to provide specific functionailty.
8+
"""
9+
110
import types
211
from functools import wraps, partial
312
import datetime

pandas/core/groupby/ops.py

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
"""
2-
Perform the groupby aggregate operations. These are not exposed
3-
to the user and provide implementations of the grouping
4-
operations. These are generally called via the *GroupBy objects.
2+
Provide classe to perform the groupby aggregate operations.
3+
4+
These are not exposed to the user and provide implementations of the grouping
5+
operations, primarily in cython. These classes (BaseGrouper and BinGrouper)
6+
are contained *in* the SeriesGroupBy and DataFrameGroupBy objects.
57
"""
68

79
import copy

0 commit comments

Comments
 (0)