Skip to content

Commit bd7db4d

Browse files
DOC: fix SA01 for pandas.PeriodDtype (#59674)
1 parent cf82a45 commit bd7db4d

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7474
-i "pandas.Period.freq GL08" \
7575
-i "pandas.Period.ordinal GL08" \
7676
-i "pandas.Period.to_timestamp SA01" \
77-
-i "pandas.PeriodDtype SA01" \
7877
-i "pandas.PeriodDtype.freq SA01" \
7978
-i "pandas.RangeIndex PR07" \
8079
-i "pandas.RangeIndex.from_range PR01,SA01" \

pandas/core/dtypes/dtypes.py

+8
Original file line numberDiff line numberDiff line change
@@ -986,6 +986,14 @@ class PeriodDtype(PeriodDtypeBase, PandasExtensionDtype):
986986
-------
987987
None
988988
989+
See Also
990+
--------
991+
Period : Represents a single time period.
992+
PeriodIndex : Immutable index for period data.
993+
date_range : Return a fixed frequency DatetimeIndex.
994+
Series : One-dimensional array with axis labels.
995+
DataFrame : Two-dimensional, size-mutable, potentially heterogeneous tabular data.
996+
989997
Examples
990998
--------
991999
>>> pd.PeriodDtype(freq="D")

0 commit comments

Comments
 (0)