Skip to content

Commit fb11912

Browse files
TomAugspurgerjreback
authored andcommitted
DOC: Fixed PeriodArray api ref (#25526)
1 parent fc24c2c commit fb11912

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

doc/source/reference/arrays.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Every period in a ``PeriodArray`` must have the same ``freq``.
259259
.. autosummary::
260260
:toctree: api/
261261

262-
arrays.DatetimeArray
262+
arrays.PeriodArray
263263
PeriodDtype
264264

265265
.. _api.arrays.interval:

pandas/core/arrays/period.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,16 @@ class PeriodArray(dtl.DatetimeLikeArrayMixin, dtl.DatelikeOps):
105105
is an ndarray of integers, when `freq` is required. When `values`
106106
is a PeriodArray (or box around), it's checked that ``values.freq``
107107
matches `freq`.
108+
dtype : PeriodDtype, optional
109+
A PeriodDtype instance from which to extract a `freq`. If both
110+
`freq` and `dtype` are specified, then the frequencies must match.
108111
copy : bool, default False
109112
Whether to copy the ordinals before storing.
110113
111114
See Also
112115
--------
113116
period_array : Create a new PeriodArray.
114-
pandas.PeriodIndex : Immutable Index for period data.
117+
PeriodIndex : Immutable Index for period data.
115118
116119
Notes
117120
-----

0 commit comments

Comments
 (0)