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.

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

DOC: update PeriodArray docstring #37251

Merged
merged 2 commits into from
Oct 21, 2020
Merged

DOC: update PeriodArray docstring #37251

merged 2 commits into from
Oct 21, 2020

Conversation

arw2019
Copy link
Member

@arw2019 arw2019 commented Oct 19, 2020

jbrockmendel
jbrockmendel reviewed Oct 19, 2020
View reviewed changes
pandas/core/arrays/period.py
@@ -67,7 +67,7 @@ class PeriodArray(PeriodMixin, dtl.DatelikeOps):
"""
Pandas ExtensionArray for storing Period data.

Users should use :func:`period_array` to create new instances.
Users should use :func:`period_range` to create new instances.
Copy link
Member

Choose a reason for hiding this comment

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

period_array is correct

Copy link
Member

Choose a reason for hiding this comment

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

It's not public, see also the linked issue

jorisvandenbossche
jorisvandenbossche reviewed Oct 19, 2020
View reviewed changes
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

@arw2019 thanks for the PR.
I would also mention pd.array(..) as the way to create a PeriodArray from a sequence of Period scalars.

@jorisvandenbossche jorisvandenbossche added this to the 1.2 milestone Oct 19, 2020
@arw2019
Copy link
Member Author

arw2019 commented Oct 20, 2020

@arw2019 thanks for the PR.
I would also mention pd.array(..) as the way to create a PeriodArray from a sequence of Period scalars.

Added

@jorisvandenbossche
Copy link
Member

Thanks for the update!

@jorisvandenbossche jorisvandenbossche merged commit a349462 into pandas-dev:master Oct 21, 2020
@jorisvandenbossche
Copy link
Member

Small development related comment: can you generally try to avoid rebasing / force pushing to a branch, but rather only add new commits? (which means merging master instead of rebasing to update to latest master) Github works better that way (eg you can specifically see the new changes since your last review) making reviewing easier.
(not of any concern of course for this specific PR of small size ;))

JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Oct 26, 2020
@arw2019 @JulianWgs
DOC: update PeriodArray docstring (pandas-dev#37251)
8e4c70f
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
@arw2019
DOC: update PeriodArray docstring (pandas-dev#37251)
f7bdfe4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jbrockmendel jbrockmendel jbrockmendel left review comments

@jorisvandenbossche jorisvandenbossche jorisvandenbossche approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.2
Development

Successfully merging this pull request may close these issues.

DOC: update PeriodArray docstring
3 participants
@arw2019 @jorisvandenbossche @jbrockmendel