Skip to content

DOC/REF: Rolling/Expanding/EWM docstrings #39219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 39 commits into from
Feb 4, 2021

Conversation

mroeschke
Copy link
Member

  • Ensure all linting tests pass, see here for how to run them

  • Create a new window/doc.py file for common template

  • Using @doc decorator instead of @Appender

  • Standardize descriptions and sections

Screen Shot 2021-01-16 at 5 06 52 PM

@mroeschke mroeschke added Docs Window rolling, ewma, expanding labels Jan 17, 2021
@mroeschke mroeschke added this to the 1.3 milestone Jan 17, 2021
@jreback
Copy link
Contributor

jreback commented Jan 19, 2021

cc @jorisvandenbossche @simonjayhawkins if you have any comments

dtype: float64
"""
),
)
def std(self, ddof: int = 1, *args, **kwargs):
Copy link
Member

Choose a reason for hiding this comment

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

OT i don't think *args should be used after the keyword argument ddof, mypy normally complains about the function receiving multiple values for argument.

@mroeschke
Copy link
Member Author

mroeschke commented Jan 19, 2021

I might need a precursor PR to align function signatures.

@jreback thoughts on all functions having a signature of def func(*args, <keyword_only_arguments>, **kwargs)?

Though *args, **kwargs may never be used.

EDIT: Nevermind

@jreback
Copy link
Contributor

jreback commented Jan 21, 2021

hmm somthing going wrong on the docs build

@mroeschke
Copy link
Member Author

Fixed the doc build failing tests and all green.

Refactored now to omit empty sections.

@mroeschke mroeschke mentioned this pull request Jan 25, 2021
3 tasks
@jreback
Copy link
Contributor

jreback commented Jan 25, 2021

ahh can you rebase

@jreback
Copy link
Contributor

jreback commented Jan 26, 2021

cc @simonjayhawkins @jorisvandenbossche if any other comments.

Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @mroeschke lgtm.

@mroeschke mroeschke mentioned this pull request Jan 26, 2021
32 tasks
@mroeschke
Copy link
Member Author

Going to merge and can address any follow ups in another PR

@mroeschke mroeschke merged commit 8dc4341 into pandas-dev:master Feb 4, 2021
@mroeschke mroeschke deleted the ref/rolling_docs branch February 4, 2021 00:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Window rolling, ewma, expanding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants