Skip to content

DOC: update the pandas.core.window.x.mean docstring#20265

Merged
jorisvandenbossche merged 3 commits intopandas-dev:masterfrom
johnnymetz:docstring-window-mean
Mar 17, 2018
Merged

DOC: update the pandas.core.window.x.mean docstring#20265
jorisvandenbossche merged 3 commits intopandas-dev:masterfrom
johnnymetz:docstring-window-mean

Conversation

@johnnymetz
Copy link
Copy Markdown
Contributor

@johnnymetz johnnymetz commented Mar 11, 2018

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

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

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

(pandas_dev) lilcrawford:pandas $ python scripts/validate_docstrings.py pandas.core.window.Window.mean

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

Calculate the window mean of the values.

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

Returns
-------
Series or DataFrame
    Returned object type is determined by the caller of the window
    calculation.

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

Examples
--------
The below example will show rolling mean calculations with window sizes of
two and three, respectively.

>>> s = pd.Series([1, 2, 3, 4])
>>> s.rolling(2).mean()
0    NaN
1    1.5
2    2.5
3    3.5
dtype: float64
>>> s.rolling(3).mean()
0    NaN
1    NaN
2    2.0
3    3.0
dtype: float64

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

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

(pandas_dev) lilcrawford:pandas $ python scripts/validate_docstrings.py pandas.core.window.Rolling.mean

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

Calculate the rolling mean of the values.

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

Returns
-------
Series or DataFrame
    Returned object type is determined by the caller of the rolling
    calculation.

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

Examples
--------
The below example will show rolling mean calculations with window sizes of
two and three, respectively.

>>> s = pd.Series([1, 2, 3, 4])
>>> s.rolling(2).mean()
0    NaN
1    1.5
2    2.5
3    3.5
dtype: float64
>>> s.rolling(3).mean()
0    NaN
1    NaN
2    2.0
3    3.0
dtype: float64

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

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

(pandas_dev) lilcrawford:pandas $ python scripts/validate_docstrings.py pandas.core.window.Expanding.mean

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

Calculate the expanding mean of the values.

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

Returns
-------
Series or DataFrame
    Returned object type is determined by the caller of the expanding
    calculation.

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

Examples
--------
The below example will show rolling mean calculations with window sizes of
two and three, respectively.

>>> s = pd.Series([1, 2, 3, 4])
>>> s.rolling(2).mean()
0    NaN
1    1.5
2    2.5
3    3.5
dtype: float64
>>> s.rolling(3).mean()
0    NaN
1    NaN
2    2.0
3    3.0
dtype: float64

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

Errors found:
	No extended summary found
	Errors in parameters section
		Parameters {'args', 'kwargs'} not documented
		Unknown parameters {'**kwargs', '*args'}
		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
Copy link
Copy Markdown
Member

WillAyd commented Mar 11, 2018

lgtm

jreback
jreback requested changes Mar 11, 2018
View reviewed changes
pandas/core/window.py
2 2.5
3 3.5
dtype: float64
>>> s.rolling(3).mean()
Copy link
Copy Markdown
Contributor

@jreback jreback Mar 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a blank line between cases

@jreback jreback added Reshaping Concat, Merge/Join, Stack/Unstack, Explode Numeric Operations Arithmetic, Comparison, and Logical operations labels Mar 11, 2018
@pep8speaks
Copy link
Copy Markdown

pep8speaks commented Mar 12, 2018 •
edited
Loading

Hello @johnnymetz! Thanks for updating the PR.

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

Comment last updated on March 12, 2018 at 07:30 Hours UTC

@johnnymetz
Copy link
Copy Markdown
Contributor Author

johnnymetz commented Mar 12, 2018

Blank line added!

jorisvandenbossche
jorisvandenbossche approved these changes Mar 17, 2018
View reviewed changes
Copy link
Copy Markdown
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@jorisvandenbossche jorisvandenbossche merged commit ad50b1d into pandas-dev:master Mar 17, 2018
@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Mar 17, 2018
nehiljain added a commit to nehiljain/pandas that referenced this pull request Mar 21, 2018
@nehiljain
Merge remote-tracking branch 'upstream/master' into docstrings_datafr…
66dab96 
…ame_describe

* upstream/master: (158 commits)
  Add link to "Craft Minimal Bug Report" blogpost (pandas-dev#20431)
  BUG: fixed json_normalize for subrecords with NoneTypes (pandas-dev#20030) (pandas-dev#20399)
  BUG: ExtensionArray.fillna for scalar values (pandas-dev#20412)
  DOC" update the Pandas core window rolling count docstring" (pandas-dev#20264)
  DOC: update the pandas.DataFrame.plot.hist docstring (pandas-dev#20155)
  DOC: Only use ~ in class links to hide prefixes. (pandas-dev#20402)
  Bug: Allow np.timedelta64 objects to index TimedeltaIndex (pandas-dev#20408)
  DOC: add disallowing of Series construction of len-1 list with index to whatsnew (pandas-dev#20392)
  MAINT: Remove weird pd file
  DOC: update the Index.isin docstring (pandas-dev#20249)
  BUG: Handle all-NA blocks in concat (pandas-dev#20382)
  DOC: update the pandas.core.resample.Resampler.fillna docstring (pandas-dev#20379)
  BUG: Don't raise exceptions splitting a blank string (pandas-dev#20067)
  DOC: update the pandas.DataFrame.cummax docstring (pandas-dev#20336)
  DOC: update the pandas.core.window.x.mean docstring (pandas-dev#20265)
  DOC: update the api.types.is_number docstring (pandas-dev#20196)
  Fix linter (pandas-dev#20389)
  DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta (pandas-dev#20142)
  DOC: update the pandas.Series.dt.is_month_end docstring (pandas-dev#20181)
  DOC: update the window.Rolling.min docstring (pandas-dev#20263)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jreback jreback jreback requested changes

@jorisvandenbossche jorisvandenbossche jorisvandenbossche approved these changes

Assignees

No one assigned

Labels

Docs Numeric Operations Arithmetic, Comparison, and Logical operations Reshaping Concat, Merge/Join, Stack/Unstack, Explode

Projects

None yet

Milestone

0.23.0

Development

Successfully merging this pull request may close these issues.

5 participants

@johnnymetz @WillAyd @pep8speaks @jreback @jorisvandenbossche