DOC: create a table for period aliases #53530
Conversation
|
@MarcoGorelli, could you please take a look at this pr? |
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/53530/ |
There was a problem hiding this comment.
Nice table! Great to have this, thanks, this will help users
I just have a comment - you write "we will refer to these aliases as period aliases", but then in the to_period docstring you write "period strings". Perhaps that should say "period aliases" instead?
cc @jbrockmendel in case you have any comments
Thank you, @MarcoGorelli for the comment. I corrected |
doc/source/user_guide/timeseries.rst
Outdated
| "D", "calendar day frequency" | ||
| "W", "weekly frequency" | ||
| "M", "monthly frequency" | ||
| "Q", "quarter end frequency" |
There was a problem hiding this comment.
Wait, for period there is no "end", should this be "quarter frequency"?
There was a problem hiding this comment.
Oops, my mistake. I'll correct it.
Update:
to keep all frequencies in a similar style I changed quarter end to quarterly. The same for year end frequency.
|
Thanks @natmokval |
* DOC: table for period aliases * correct the to_period docstrings * change quarter/year end to quarterly/yearly
related to pr #53477
Updated documentation for Time series / date functionality
Created a new table for
period aliases. Added to the doc ofPeriod dtypesreference to the tableperiod aliasesinstead of offset aliases. Corrected docs forto_period. Pointed out that only frequencies from the tableperiod aliasesare valid forto_period.