Skip to content

Commit 829c700

Browse files
committed
more info in docs
1 parent 867a60a commit 829c700

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

janitor/functions/summarize.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ def summarize(
2020
2121
!!! info "New in version 0.25.0"
2222
23+
!!!note
24+
25+
Before reaching for `summarize`, try `pd.DataFrame.agg`.
26+
2327
Reduction operation on columns via a tuple.
2428
2529
It is a wrapper around `pd.DataFrame.agg`,
2630
with added flexibility for multiple columns.
2731
28-
Before reaching for `summarize`, try `pd.DataFrame.agg`.
29-
3032
The argument should be of the form `(columns, func, names_glue)`;
3133
the `names_glue` argument is optional.
3234
`columns` can be selected with the
@@ -35,6 +37,7 @@ def summarize(
3537
The function `func` should be a string
3638
(which is dispatched to `pd.Series.agg`),
3739
or a callable, or a list/tuple of strings/callables.
40+
The function is called on each column in `columns`.
3841
3942
The `names_glue` argument allows for renaming, especially for
4043
multiple columns or multiple functions.

0 commit comments

Comments
 (0)