Skip to content

Commit 533ce34

Browse files
committed
STY: Fix long lines in docstrings
1 parent 496db1c commit 533ce34

File tree

1 file changed

+43
-20
lines changed

1 file changed

+43
-20
lines changed

pandas/core/window/rolling.py

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,7 +1242,8 @@ def aggregate(self, func=None, *args, **kwargs):
12421242
----------
12431243
func : function, str, list or dict
12441244
Function to use for aggregating the data. If a function, must either
1245-
work when passed a Series/DataFrame or when passed to Series/DataFrame.apply.
1245+
work when passed a Series/DataFrame or
1246+
when passed to Series/DataFrame.apply.
12461247
12471248
Accepted combinations are:
12481249
@@ -2069,7 +2070,8 @@ def aggregate(self, func=None, *args, **kwargs):
20692070
----------
20702071
func : function, str, list or dict
20712072
Function to use for aggregating the data. If a function, must either
2072-
work when passed a Series/Dataframe or when passed to Series/Dataframe.apply.
2073+
work when passed a Series/Dataframe or
2074+
when passed to Series/Dataframe.apply.
20732075
20742076
Accepted combinations are:
20752077
@@ -2220,7 +2222,8 @@ def apply(
22202222
* ``'cython'`` : Runs rolling apply through C-extensions from cython.
22212223
* ``'numba'`` : Runs rolling apply through JIT compiled code from numba.
22222224
Only available when ``raw`` is set to ``True``.
2223-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2225+
* ``None`` : Defaults to ``'cython'`` or
2226+
globally setting ``compute.use_numba``
22242227
22252228
engine_kwargs : dict, default None
22262229
* For ``'cython'`` engine, there are no accepted ``engine_kwargs``
@@ -2294,14 +2297,16 @@ def pipe(
22942297
Apply a ``func`` with arguments to this Rolling object and return its result.
22952298
22962299
Use `.pipe` when you want to improve readability by chaining together
2297-
functions that expect Series, DataFrames, GroupBy, Rolling, Expanding or Resampler
2300+
functions that expect
2301+
Series, DataFrames, GroupBy, Rolling, Expanding or Resampler
22982302
objects.
22992303
Instead of writing
23002304
23012305
>>> h = lambda x, arg2, arg3: x + 1 - arg2 * arg3
23022306
>>> g = lambda x, arg1: x * 5 / arg1
23032307
>>> f = lambda x: x ** 4
2304-
>>> df = pd.DataFrame({'A': [1, 2, 3, 4]}, index=pd.date_range('2012-08-02', periods=4))
2308+
>>> df = pd.DataFrame({'A': [1, 2, 3, 4]},
2309+
index=pd.date_range('2012-08-02', periods=4))
23052310
>>> h(g(f(df.rolling('2D')), arg1=1), arg2=2, arg3=3) # doctest: +SKIP
23062311
23072312
You can write
@@ -2354,7 +2359,8 @@ def pipe(
23542359
2012-08-04 3
23552360
2012-08-05 4
23562361
2357-
To get the difference between each rolling 2-day window's maximum and minimum
2362+
To get the difference between each rolling
2363+
2-day window's maximum and minimum
23582364
value in one pass, you can do
23592365
23602366
>>> df.rolling('2D').pipe(lambda x: x.max() - x.min())
@@ -2385,7 +2391,8 @@ def sum(
23852391
engine : str, default None
23862392
* ``'cython'`` : Runs the operation through C-extensions from cython.
23872393
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2388-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2394+
* ``None`` : Defaults to ``'cython'`` or
2395+
globally setting ``compute.use_numba``
23892396
23902397
.. versionadded:: 1.3.0
23912398
@@ -2412,7 +2419,9 @@ def sum(
24122419
24132420
Notes
24142421
-----
2415-
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.
2422+
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba`
2423+
for extended documentation and performance considerations
2424+
for the Numba engine.
24162425
24172426
Examples
24182427
--------
@@ -2490,7 +2499,8 @@ def max(
24902499
engine : str, default None
24912500
* ``'cython'`` : Runs the operation through C-extensions from cython.
24922501
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2493-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2502+
* ``None`` : Defaults to ``'cython'`` or
2503+
globally setting ``compute.use_numba``
24942504
24952505
.. versionadded:: 1.3.0
24962506
@@ -2520,7 +2530,9 @@ def max(
25202530
25212531
Notes
25222532
-----
2523-
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.
2533+
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba`
2534+
for extended documentation and performance considerations
2535+
for the Numba engine.
25242536
25252537
Examples
25262538
--------
@@ -2557,7 +2569,8 @@ def min(
25572569
engine : str, default None
25582570
* ``'cython'`` : Runs the operation through C-extensions from cython.
25592571
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2560-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2572+
* ``None`` : Defaults to ``'cython'`` or
2573+
globally setting ``compute.use_numba``
25612574
25622575
.. versionadded:: 1.3.0
25632576
@@ -2584,7 +2597,9 @@ def min(
25842597
25852598
Notes
25862599
-----
2587-
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.
2600+
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba`
2601+
for extended documentation and performance considerations
2602+
for the Numba engine.
25882603
25892604
Examples
25902605
--------
@@ -2624,7 +2639,8 @@ def mean(
26242639
engine : str, default None
26252640
* ``'cython'`` : Runs the operation through C-extensions from cython.
26262641
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2627-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2642+
* ``None`` : Defaults to ``'cython'`` or
2643+
globally setting ``compute.use_numba``
26282644
26292645
.. versionadded:: 1.3.0
26302646
@@ -2651,7 +2667,9 @@ def mean(
26512667
26522668
Notes
26532669
-----
2654-
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.
2670+
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba`
2671+
for extended documentation and performance considerations
2672+
for the Numba engine.
26552673
26562674
Examples
26572675
--------
@@ -2698,7 +2716,8 @@ def median(
26982716
engine : str, default None
26992717
* ``'cython'`` : Runs the operation through C-extensions from cython.
27002718
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2701-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2719+
* ``None`` : Defaults to ``'cython'`` or
2720+
globally setting ``compute.use_numba``
27022721
27032722
.. versionadded:: 1.3.0
27042723
@@ -2725,7 +2744,9 @@ def median(
27252744
27262745
Notes
27272746
-----
2728-
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.
2747+
See :ref:`window.numba_engine` and :ref:`enhancingperf.numba`
2748+
for extended documentation and performance considerations
2749+
for the Numba engine.
27292750
27302751
Examples
27312752
--------
@@ -2769,7 +2790,8 @@ def std(
27692790
engine : str, default None
27702791
* ``'cython'`` : Runs the operation through C-extensions from cython.
27712792
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2772-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2793+
* ``None`` : Defaults to ``'cython'`` or
2794+
globally setting ``compute.use_numba``
27732795
27742796
.. versionadded:: 1.4.0
27752797
@@ -2845,7 +2867,8 @@ def var(
28452867
engine : str, default None
28462868
* ``'cython'`` : Runs the operation through C-extensions from cython.
28472869
* ``'numba'`` : Runs the operation through JIT compiled code from numba.
2848-
* ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
2870+
* ``None`` : Defaults to ``'cython'`` or
2871+
globally setting ``compute.use_numba``
28492872
28502873
.. versionadded:: 1.4.0
28512874
@@ -3187,7 +3210,7 @@ def rank(
31873210
"""
31883211
Calculate the rolling rank.
31893212
3190-
.. versionadded:: 1.4.0
3213+
.. versionadded:: 1.4.0
31913214
31923215
Parameters
31933216
----------
@@ -3264,7 +3287,7 @@ def nunique(
32643287
"""
32653288
Calculate the rolling nunique.
32663289
3267-
.. versionadded:: 3.0.0
3290+
.. versionadded:: 3.0.0
32683291
32693292
Parameters
32703293
----------

0 commit comments

Comments
 (0)