Skip to content

DOC: update PeriodArray docstring #37237

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.

Sign up for GitHub

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

Jump to bottom
Closed
arw2019 opened this issue Oct 19, 2020 · 1 comment · Fixed by #37251
Closed

DOC: update PeriodArray docstring #37237

arw2019 opened this issue Oct 19, 2020 · 1 comment · Fixed by #37251
Labels
Docs Period Period data type
Milestone
1.2

Comments

@arw2019
Copy link
Member

arw2019 commented Oct 19, 2020

AFAICT we currently don't have dedicated pages for these methods in the API reference.

When we add them we also want add links on the pd.PeriodArray page (and possibly in other places)
@arw2019 arw2019 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 19, 2020
@jorisvandenbossche
Copy link
Member

I think we should actually update the docstring of PeriodArray, because period_array is not public. As far as I know, the recommendation would be to either use pd.period_range(..) or pd.array(..).

The PeriodIndex docs are listed here: https://pandas.pydata.org/pandas-docs/stable/reference/indexing.html#periodindex

@jorisvandenbossche jorisvandenbossche added Period Period data type and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 19, 2020
@arw2019 arw2019 changed the title DOC: add period_array, PeriodIndex pages to API reference DOC: update PeriodArray docstring Oct 19, 2020
@arw2019 arw2019 mentioned this issue Oct 19, 2020
Merged
5 tasks
@jorisvandenbossche jorisvandenbossche added this to the 1.2 milestone Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Period Period data type
Projects
None yet
Milestone
1.2
Development

Successfully merging a pull request may close this issue.

DOC: update PeriodArray docstring arw2019/pandas
2 participants
@jorisvandenbossche @arw2019