Skip to content

Commit 8dd7aa3

Browse files
authored
Update groupby docstring to make orderedness explicitly not guaranteed (#104)
Update docs for groupby based on the discussion in gh-102
1 parent 9968d87 commit 8dd7aa3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

spec/API_specification/dataframe_api/dataframe_object.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,28 @@
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+
Downstream operations from this function, like aggregations, return
34+
results for which row order is not guaranteed and is implementation
35+
defined.
1736
"""
1837
...
1938

0 commit comments

Comments
 (0)