The documentation around frequency strings is unclear

[mineo]

http://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.rolling.html?highlight=rolling#pandas.DataFrame.rolling and various other places in the documentation talk about something called "frequency strings", however, there doesn't seem to be any explanation of what this term means anywhere. http://pandas.pydata.org/pandas-docs/stable/timeseries.html#dateoffset-objects mentions the term again without explaining it. From the few examples I found, I now think http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases (note that this is after the dateoffset objects in the documentation) is the complete list of frequency strings, but for some reason they're called "offset aliases" here. Are those the frequency strings? If not, where are they defined?

[sinhrks]

I think another confusion is caused by legacy aliases. We've formally deprecated legacy offsets in 0.17 (#10951), thus 0.19 may be a good timing to re-organize the doc (including your point).

[ckrapu]

I'd like to take this for my first PR. Could it be assigned to me?

[jreback]

@ckrapu go ahead an submit a PR when you are ready.

[sahildua2305]

@ckrapu are you still working on this? If not, I'd like to work on this. Please let me know.

[ckrapu]

Nope, all yours. I got stuck trying to build the docs and sort out what
actually needed to be edited. If you do work on it, I'd really like to see
what you end up doing, as a sort of tutorial.
On Jul 12, 2016 5:20 PM, "Sahil Dua" [email protected] wrote:

@ckrapu https://github.com/ckrapu are you still working on this? If
not, I'd like to work on this. Please let me know.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#13160 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/AKBR4ia-wV3-LxXts89gPTK3Pd5w9kwrks5qVAU4gaJpZM4IdYXW
.

[sahildua2305]

Awesome!

@jreback can you please suggest some ideas about including the point mentioned by @mineo? One thing can be including the link to this explanation wherever frequency string is mentioned/used. Other approach I can think of is to bring the same explanation part in the beginning.

Am I thinking in the right direction?

[jreback]

sure u can include the link

[sahildua2305]

@jreback I am not sure from where I can edit this page. I think that it's coming up from the Class documentation in window.py. Should I add additional note for the frequency strings here?

[jreback]

that page is the actual doc-string defined in window.py

docs themselves r in pandas/doc/source

[sahildua2305]

Thanks! I'll submit the PR in a while.

[jorisvandenbossche]

@ckrapu If you got stuck with building the docs, always welcome to specify what the problem was, so we can try to make contributing to the documentation as easy as possible