From ab1b1ad587ab7aa09ed979cc2b3ecc4ce661f33e Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Wed, 7 Mar 2018 13:48:41 -0800 Subject: [PATCH 1/6] Continued updates to kurt docstr --- pandas/core/window.py | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index cef012bb33e9f..6a754bbdc8e75 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -910,8 +910,9 @@ def skew(self, **kwargs): Returns ------- - Series or DataFrame (matches input) - Like-indexed object containing the result of function application + Series or DataFrame + Returned object type is dictated by the caller of the %(name)s + calculation See Also -------- @@ -932,19 +933,20 @@ def skew(self, **kwargs): four matching the equivalent function call using `scipy.stats`. >>> arr = [1, 2, 3, 4, 999] + >>> fmt = "{0:.6f}" # limit the printed precision to 6 digits >>> import scipy.stats - >>> print("{0:.6f}".format(scipy.stats.kurtosis(arr[:-1], bias=False))) + >>> print(fmt.format(scipy.stats.kurtosis(arr[:-1], bias=False))) -1.200000 - >>> print("{0:.6f}".format(scipy.stats.kurtosis(arr[1:], bias=False))) + >>> print(fmt.format(scipy.stats.kurtosis(arr[1:], bias=False))) 3.999946 - >>> df = pd.DataFrame(arr) - >>> df.rolling(4).kurt() - 0 - 0 NaN - 1 NaN - 2 NaN - 3 -1.200000 - 4 3.999946 + >>> ser = pd.Series(arr) + >>> ser.rolling(4).kurt() + 0 NaN + 1 NaN + 2 NaN + 3 -1.200000 + 4 3.999946 + dtype: float64 """) def kurt(self, **kwargs): From 471499bd3d2d5c94bd974bb12a429a39c6b88f85 Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Wed, 7 Mar 2018 15:44:30 -0800 Subject: [PATCH 2/6] Minor docstring updates --- pandas/core/window.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index 6a754bbdc8e75..eb993f70b3900 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -911,8 +911,8 @@ def skew(self, **kwargs): Returns ------- Series or DataFrame - Returned object type is dictated by the caller of the %(name)s - calculation + Returned object type is determined by the caller of the %(name)s + calculation See Also -------- @@ -939,8 +939,8 @@ def skew(self, **kwargs): -1.200000 >>> print(fmt.format(scipy.stats.kurtosis(arr[1:], bias=False))) 3.999946 - >>> ser = pd.Series(arr) - >>> ser.rolling(4).kurt() + >>> s = pd.Series(arr) + >>> s.rolling(4).kurt() 0 NaN 1 NaN 2 NaN From 2fb401166c9cb41b8d2f6b03294c8274ce0a5ba1 Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Thu, 8 Mar 2018 13:13:53 -0800 Subject: [PATCH 3/6] Added See Also descriptions --- pandas/core/window.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index eb993f70b3900..093020e97ecaf 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -916,12 +916,12 @@ def skew(self, **kwargs): See Also -------- - pandas.Series.%(name)s - pandas.DataFrame.%(name)s - pandas.Series.kurtosis - pandas.DataFrame.kurtosis - scipy.stats.skew - scipy.stats.kurtosis + pandas.Series.%(name)s : Calling object with Series data + pandas.DataFrame.%(name)s : Calling object with DataFrames + pandas.Series.kurtosis : Similar method for Series + pandas.DataFrame.kurtosis : Similar method for DataFrame + scipy.stats.skew : Third moment of a probability density + scipy.stats.kurtosis : Reference SciPy method Notes ----- From efa70267a392a1ca950b0cf538d92df328c0e15e Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Thu, 8 Mar 2018 14:08:47 -0800 Subject: [PATCH 4/6] Updated **kwargs Parameter --- pandas/core/window.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index 093020e97ecaf..d9b6f8831b0b5 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -906,7 +906,8 @@ def skew(self, **kwargs): Parameters ---------- - kwargs : Under Review + **kwargs + Under Review. Returns ------- From ffaa01f8e0ee997d3b12181133e8bc1fa23c1eba Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Thu, 8 Mar 2018 18:17:29 -0800 Subject: [PATCH 5/6] Updated See Also --- pandas/core/window.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index d9b6f8831b0b5..837b29f12db14 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -917,10 +917,10 @@ def skew(self, **kwargs): See Also -------- - pandas.Series.%(name)s : Calling object with Series data - pandas.DataFrame.%(name)s : Calling object with DataFrames - pandas.Series.kurtosis : Similar method for Series - pandas.DataFrame.kurtosis : Similar method for DataFrame + Series.%(name)s : Calling object with Series data + DataFrame.%(name)s : Calling object with DataFrames + Series.kurt : Like method for Series + DataFrame.kurt : Like method for DataFrame scipy.stats.skew : Third moment of a probability density scipy.stats.kurtosis : Reference SciPy method From 083d0e578cbe093c0bbc433c1d7a4a47ac56e15d Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Fri, 9 Mar 2018 11:36:27 +0100 Subject: [PATCH 6/6] Update window.py --- pandas/core/window.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/window.py b/pandas/core/window.py index 837b29f12db14..c41b07759d555 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -919,8 +919,8 @@ def skew(self, **kwargs): -------- Series.%(name)s : Calling object with Series data DataFrame.%(name)s : Calling object with DataFrames - Series.kurt : Like method for Series - DataFrame.kurt : Like method for DataFrame + Series.kurt : Equivalent method for Series + DataFrame.kurt : Equivalent method for DataFrame scipy.stats.skew : Third moment of a probability density scipy.stats.kurtosis : Reference SciPy method