Skip to content

DOC: update PeriodArray docstring #37251

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

Merged
merged 2 commits into from
Oct 21, 2020
Merged

DOC: update PeriodArray docstring #37251

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d3bd12
DOC: update PeriodArray docstring
arw2019 Oct 19, 2020
3e3622a
feedback
arw2019 Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions pandas/core/arrays/period.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ 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

Alternatively, :func:`array` can be used to create new instances
from a sequence of Period scalars.

Parameters
----------
Expand Down Expand Up @@ -97,8 +99,10 @@ class PeriodArray(PeriodMixin, dtl.DatelikeOps):

See Also
--------
period_array : Create a new PeriodArray.
Period: Represents a period of time.
PeriodIndex : Immutable Index for period data.
period_range: Create a fixed-frequency PeriodArray.
array: Construct a pandas array.

Notes
-----
Expand Down