Skip to content

Commit fa937aa

Browse files
DOC: fix SA01 for pandas.Period.is_leap_year (#58839)
1 parent 07e8e54 commit fa937aa

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9797
-i "pandas.Period.asfreq SA01" \
9898
-i "pandas.Period.freq GL08" \
9999
-i "pandas.Period.freqstr SA01" \
100-
-i "pandas.Period.is_leap_year SA01" \
101100
-i "pandas.Period.month SA01" \
102101
-i "pandas.Period.now SA01" \
103102
-i "pandas.Period.ordinal GL08" \

pandas/_libs/tslibs/period.pyx

+6
Original file line numberDiff line numberDiff line change
@@ -2443,6 +2443,12 @@ cdef class _Period(PeriodMixin):
24432443
"""
24442444
Return True if the period's year is in a leap year.
24452445

2446+
See Also
2447+
--------
2448+
Timestamp.is_leap_year : Check if the year in a Timestamp is a leap year.
2449+
DatetimeIndex.is_leap_year : Boolean indicator if the date belongs to a
2450+
leap year.
2451+
24462452
Examples
24472453
--------
24482454
>>> period = pd.Period('2022-01', 'M')

0 commit comments

Comments
 (0)