DOC: Update the pandas.core.window.x.sum docstring #20272

othersideoflearning · 2018-03-11T03:55:19Z

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

[x ] PR title is "DOC: update the docstring"
[x ] The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
[x ] The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
[x ] The html version looks good: python doc/make.py --single <your-function-or-method>
[ x] It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

# paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
# between the "```" 
(pandas-dev) D:\GitHub\pandas>python scripts/validate_docstrings.py pandas.core.window.Rolling.sum

################################################################################
################## Docstring (pandas.core.window.Rolling.sum) ##################
################################################################################

Calculate rolling sum of given DataFrame or Series.

Parameters
----------
*args
    Under Review.
**kwargs
    Under Review.

Returns
-------
Series or DataFrame
    Like-indexed object containing the result of function application

See Also
--------
Series.rolling : Calling object with Series data
DataFrame.rolling  : Calling object with DataFrame data
Series.sum  : Equivalent method for Series
DataFrame.sum   : Equivalent method for DataFrame

Examples
--------
>>> s = pd.Series([1, 2, 3, 4, 5])
>>> s.rolling(3).sum()
0     NaN
1     NaN
2     6.0
3     9.0
4    12.0
dtype: float64
>>> s.expanding(3).sum()
0     NaN
1     NaN
2     6.0
3    10.0
4    15.0
dtype: float64
>>> s.rolling(3, center=True).sum()
0     NaN
1     6.0
2     9.0
3    12.0
4     NaN
dtype: float64

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
        No extended summary found
        Errors in parameters section
                Parameters {'kwargs', 'args'} not documented
                Unknown parameters {'**kwargs', '*args'}
                Parameter "*args" has no type
                Parameter "**kwargs" has no type

(pandas-dev) D:\GitHub\pandas>python scripts/validate_docstrings.py pandas.core.window.Expanding.sum

################################################################################
################# Docstring (pandas.core.window.Expanding.sum) #################
################################################################################

Calculate expanding sum of given DataFrame or Series.

Parameters
----------
*args
    Under Review.
**kwargs
    Under Review.

Returns
-------
Series or DataFrame
    Like-indexed object containing the result of function application

See Also
--------
Series.expanding : Calling object with Series data
DataFrame.expanding  : Calling object with DataFrame data
Series.sum  : Equivalent method for Series
DataFrame.sum   : Equivalent method for DataFrame

Examples
--------
>>> s = pd.Series([1, 2, 3, 4, 5])
>>> s.rolling(3).sum()
0     NaN
1     NaN
2     6.0
3     9.0
4    12.0
dtype: float64
>>> s.expanding(3).sum()
0     NaN
1     NaN
2     6.0
3    10.0
4    15.0
dtype: float64
>>> s.rolling(3, center=True).sum()
0     NaN
1     6.0
2     9.0
3    12.0
4     NaN
dtype: float64

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
        No extended summary found
        Errors in parameters section
                Parameters {'kwargs', 'args'} not documented
                Unknown parameters {'**kwargs', '*args'}
                Parameter "*args" has no type
                Parameter "**kwargs" has no type

(pandas-dev) D:\GitHub\pandas>python scripts/validate_docstrings.py pandas.core.window.Window.sum

################################################################################
################## Docstring (pandas.core.window.Window.sum)  ##################
################################################################################

Calculate window sum of given DataFrame or Series.

Parameters
----------
*args
    Under Review.
**kwargs
    Under Review.

Returns
-------
Series or DataFrame
    Like-indexed object containing the result of function application

See Also
--------
Series.window : Calling object with Series data
DataFrame.window  : Calling object with DataFrame data
Series.sum  : Equivalent method for Series
DataFrame.sum   : Equivalent method for DataFrame

Examples
--------
>>> s = pd.Series([1, 2, 3, 4, 5])
>>> s.rolling(3).sum()
0     NaN
1     NaN
2     6.0
3     9.0
4    12.0
dtype: float64
>>> s.expanding(3).sum()
0     NaN
1     NaN
2     6.0
3    10.0
4    15.0
dtype: float64
>>> s.rolling(3, center=True).sum()
0     NaN
1     6.0
2     9.0
3    12.0
4     NaN
dtype: float64

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
        No extended summary found
        Errors in parameters section
                Parameters {'args', 'kwargs'} not documented
                Unknown parameters {'*args', '**kwargs'}
                Parameter "*args" has no type
                Parameter "**kwargs" has no type

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

WillAyd · 2018-03-11T04:25:30Z

pandas/core/window.py

+    Returns
+    -------
+    Series or DataFrame
+        Like-indexed object containing the result of function application


Period at end

WillAyd · 2018-03-11T04:26:33Z

pandas/core/window.py

+    3    10.0
+    4    15.0
+    dtype: float64
+    >>> s.rolling(3, center=True).sum()


I think this is a great example, but maybe add one line or comment for what to expect with center=True

Thank you. I have added one line of explanation stating that how this argument helps.

WillAyd · 2018-03-11T04:27:01Z

pandas/core/window.py

+    --------
+    Series.%(name)s : Calling object with Series data
+    DataFrame.%(name)s  : Calling object with DataFrame data
+    Series.sum  : Equivalent method for Series


Whitespace seems off on this line and below - are there more than one before the ":"?

yup. Deleted.

jreback · 2018-03-11T13:21:01Z

pandas/core/window.py

+    3     9.0
+    4    12.0
+    dtype: float64
+    >>> s.expanding(3).sum()


blank line between cases

I have added one line for each case.

jreback · 2018-03-11T13:21:19Z

pandas/core/window.py

@@ -639,7 +684,7 @@ def aggregate(self, arg, *args, **kwargs):
    agg = aggregate

    @Substitution(name='window')
-    @Appender(_doc_template)
+#    @Appender(_doc_template)


don't comment, simply remove

Your comments are valuable and I have deleted necessary code.

Changes to the pandas.core.window.x.sum docstring

pep8speaks · 2018-03-11T23:03:35Z

Hello @apallekonda! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 14, 2018 at 19:29 Hours UTC

othersideoflearning

Added or deleted necessary code as per comments.

othersideoflearning · 2018-03-11T23:06:59Z

pandas/core/window.py

@@ -639,7 +684,7 @@ def aggregate(self, arg, *args, **kwargs):
    agg = aggregate

    @Substitution(name='window')
-    @Appender(_doc_template)
+#    @Appender(_doc_template)


Your comments are valuable and I have deleted necessary code.

othersideoflearning · 2018-03-11T23:33:58Z

pandas/core/window.py

+    3    10.0
+    4    15.0
+    dtype: float64
+    >>> s.rolling(3, center=True).sum()


Thank you. I have added one line of explanation stating that how this argument helps.

othersideoflearning · 2018-03-11T23:34:55Z

pandas/core/window.py

+    3     9.0
+    4    12.0
+    dtype: float64
+    >>> s.expanding(3).sum()


I have added one line for each case.

othersideoflearning · 2018-03-11T23:35:16Z

pandas/core/window.py

+    --------
+    Series.%(name)s : Calling object with Series data
+    DataFrame.%(name)s  : Calling object with DataFrame data
+    Series.sum  : Equivalent method for Series


yup. Deleted.

othersideoflearning · 2018-03-11T23:35:22Z

pandas/core/window.py

+    Returns
+    -------
+    Series or DataFrame
+        Like-indexed object containing the result of function application


…sDocsprint

[ci skip]

codecov · 2018-03-14T19:27:31Z

Codecov Report

❗ No coverage uploaded for pull request base (master@c124e47). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #20272   +/-   ##
=========================================
  Coverage          ?    91.7%           
=========================================
  Files             ?      150           
  Lines             ?    49165           
  Branches          ?        0           
=========================================
  Hits              ?    45087           
  Misses            ?     4078           
  Partials          ?        0

Flag	Coverage Δ
#multiple	`90.09% <ø> (?)`
#single	`41.86% <ø> (?)`

Impacted Files	Coverage Δ
pandas/core/window.py	`96.32% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c124e47...d1a2b8d. Read the comment docs.

[ci skip]

TomAugspurger · 2018-03-14T19:30:09Z

Thanks @apallekonda !

apallekonda added 2 commits March 10, 2018 19:27

DOC: Update the pandas.core.window.x.sum docstring

4e1b71a

DOC: Update the pandas.core.window.x.sum docstring

20f82d2

WillAyd requested changes Mar 11, 2018

View reviewed changes

jorisvandenbossche added Docs and removed Docs labels Mar 11, 2018

jreback added the Reshaping Concat, Merge/Join, Stack/Unstack, Explode label Mar 11, 2018

jreback requested changes Mar 11, 2018

View reviewed changes

Update window.py

f2c4ef6

Changes to the pandas.core.window.x.sum docstring

othersideoflearning commented Mar 11, 2018

View reviewed changes

TomAugspurger added 2 commits March 14, 2018 14:20

Merge remote-tracking branch 'upstream/master' into apallekonda-panda…

5c6ca76

…sDocsprint

Updated [ci skip]

0cfe90e

[ci skip]

TomAugspurger added this to the 0.23.0 milestone Mar 14, 2018

Fixup [ci skip]

d1a2b8d

[ci skip]

TomAugspurger merged commit 002796a into pandas-dev:master Mar 14, 2018

Uh oh!

DOC: Update the pandas.core.window.x.sum docstring #20272

DOC: Update the pandas.core.window.x.sum docstring #20272

Uh oh!

Conversation

othersideoflearning commented Mar 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pep8speaks commented Mar 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated on March 14, 2018 at 19:29 Hours UTC

Uh oh!

othersideoflearning left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TomAugspurger commented Mar 14, 2018

Uh oh!

Uh oh!

pep8speaks commented Mar 11, 2018 •

edited

Loading

codecov bot commented Mar 14, 2018 •

edited

Loading