Skip to content

Commit ab80804

Browse files
committed
DOC: Fix documentation for DataFrame.groupby.transform (pandas-dev#40506)
1 parent 088cb58 commit ab80804

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

pandas/core/groupby/groupby.py

+15-15
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,19 @@ class providing the base-class of operations.
119119

120120
_apply_docs = {
121121
"template": """
122-
Apply function `func` group-wise and combine the results together.
122+
Apply function ``func`` group-wise and combine the results together.
123123
124-
The function passed to `apply` must take a {input} as its first
125-
argument and return a DataFrame, Series or scalar. `apply` will
124+
The function passed to ``apply`` must take a {input} as its first
125+
argument and return a DataFrame, Series or scalar. ``apply`` will
126126
then take care of combining the results back together into a single
127-
dataframe or series. `apply` is therefore a highly flexible
127+
dataframe or series. ``apply`` is therefore a highly flexible
128128
grouping method.
129129
130-
While `apply` is a very flexible method, its downside is that
130+
While ``apply`` is a very flexible method, its downside is that
131131
using it can be quite a bit slower than using more specific methods
132-
like `agg` or `transform`. Pandas offers a wide range of method that will
133-
be much faster than using `apply` for their specific purposes, so try to
134-
use them before reaching for `apply`.
132+
like ``agg`` or ``transform``. Pandas offers a wide range of method that will
133+
be much faster than using ``apply`` for their specific purposes, so try to
134+
use them before reaching for ``apply``.
135135
136136
Parameters
137137
----------
@@ -140,7 +140,7 @@ class providing the base-class of operations.
140140
returns a dataframe, a series or a scalar. In addition the
141141
callable may take positional and keyword arguments.
142142
args, kwargs : tuple and dict
143-
Optional positional and keyword arguments to pass to `func`.
143+
Optional positional and keyword arguments to pass to ``func``.
144144
145145
Returns
146146
-------
@@ -157,9 +157,9 @@ class providing the base-class of operations.
157157
158158
Notes
159159
-----
160-
In the current implementation `apply` calls `func` twice on the
160+
In the current implementation ``apply`` calls ``func`` twice on the
161161
first group to decide whether it can take a fast or slow code
162-
path. This can lead to unexpected behavior if `func` has
162+
path. This can lead to unexpected behavior if ``func`` has
163163
side-effects, as they will take effect twice for the first
164164
group.
165165
@@ -350,12 +350,12 @@ class providing the base-class of operations.
350350
351351
See Also
352352
--------
353-
%(klass)s.groupby.apply : Apply function func group-wise
354-
and combine the results together.
353+
%(klass)s.groupby.apply : Apply function ``func`` group-wise and combine
354+
the results together.
355355
%(klass)s.groupby.aggregate : Aggregate using one or more
356356
operations over the specified axis.
357-
%(klass)s.transform : Transforms the Series on each group
358-
based on the given function.
357+
%(klass)s.transform : Call ``func`` on self producing a %(klass)s with
358+
transformed values.
359359
360360
Notes
361361
-----

0 commit comments

Comments
 (0)