Skip to content
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

DOC: rolling_* functions: unclear docstrings #5504

Closed
jorisvandenbossche opened this issue Nov 13, 2013 · 0 comments · Fixed by #6362
Closed

DOC: rolling_* functions: unclear docstrings #5504

jorisvandenbossche opened this issue Nov 13, 2013 · 0 comments · Fixed by #6362
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs Frequency DateOffsets
Milestone

Comments

@jorisvandenbossche
Copy link
Member

E.g. for rolling_sum: http://pandas.pydata.org/pandas-docs/dev/generated/pandas.stats.moments.rolling_sum.html#pandas.stats.moments.rolling_sum

Some issues I encountered:

  • it is not mentioned the result is set to the right edge of the window.
  • the center keyword is not documented.
  • the explanation for freq (Frequency to conform to before computing statistic) is totally unclear to me. Conform how? It seems from the code it is doing a default resample, so this calculates a mean first?
  • How are NaN's handled?

And something else, an interesting feature (and what I first thought freq would do) would be that you can specify the window size as a frequency (if dealing with a datetimeindexed series/frame) instead of a number (eg a frequency of '15min' instead of n=15 if your data are every minute).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs Frequency DateOffsets
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant