From 246b390d66bb5f34081269bfee226a4aa00b8a3d Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Fri, 6 Sep 2024 09:52:37 +0530 Subject: [PATCH] DOC: fix SA01 for pandas.Period.to_timestamp --- ci/code_checks.sh | 1 - pandas/_libs/tslibs/period.pyx | 6 ++++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index fcbeb20d083d6..2fc9c1a83c097 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -73,7 +73,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.NA SA01" \ -i "pandas.Period.freq GL08" \ -i "pandas.Period.ordinal GL08" \ - -i "pandas.Period.to_timestamp SA01" \ -i "pandas.PeriodDtype.freq SA01" \ -i "pandas.RangeIndex.from_range PR01,SA01" \ -i "pandas.RangeIndex.start SA01" \ diff --git a/pandas/_libs/tslibs/period.pyx b/pandas/_libs/tslibs/period.pyx index e4771feeb804e..c563ab91c4142 100644 --- a/pandas/_libs/tslibs/period.pyx +++ b/pandas/_libs/tslibs/period.pyx @@ -2001,6 +2001,12 @@ cdef class _Period(PeriodMixin): ------- Timestamp + See Also + -------- + Timestamp : A class representing a single point in time. + Period : Represents a span of time with a fixed frequency. + PeriodIndex.to_timestamp : Convert a `PeriodIndex` to a `DatetimeIndex`. + Examples -------- >>> period = pd.Period('2023-1-1', freq='D')