Skip to content

Commit ae30a27

Browse files
committed
Update docs for groupby based on the discussion in data-apis#102
1 parent 9968d87 commit ae30a27

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

spec/API_specification/dataframe_api/dataframe_object.py

+19-1
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,27 @@
1111

1212

1313
class DataFrame:
14-
def groupby(self, keys: list[str], /) -> GroupBy:
14+
def groupby(self, keys: Sequence[str], /) -> GroupBy:
1515
"""
1616
Group the DataFrame by the given columns.
17+
18+
Parameters
19+
----------
20+
keys : Sequence[str]
21+
22+
Returns
23+
-------
24+
GroupBy
25+
26+
Raises
27+
------
28+
KeyError
29+
If any of the requested keys are not present.
30+
31+
Notes
32+
-----
33+
The order of the keys and the order of rows within each group is not
34+
guaranteed and is implementation defined.
1735
"""
1836
...
1937

0 commit comments

Comments
 (0)