Skip to content

Commit 929e8c5

Browse files
DOC: fix SA01,ES01 for pandas.Period.freqstr (#59661)
1 parent 828b6d0 commit 929e8c5

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7373
-i "pandas.NA SA01" \
7474
-i "pandas.NaT SA01" \
7575
-i "pandas.Period.freq GL08" \
76-
-i "pandas.Period.freqstr SA01" \
7776
-i "pandas.Period.ordinal GL08" \
7877
-i "pandas.Period.strftime PR01,SA01" \
7978
-i "pandas.Period.to_timestamp SA01" \

pandas/_libs/tslibs/period.pyx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2607,6 +2607,17 @@ cdef class _Period(PeriodMixin):
26072607
"""
26082608
Return a string representation of the frequency.
26092609

2610+
This property provides the frequency string associated with the `Period`
2611+
object. The frequency string describes the granularity of the time span
2612+
represented by the `Period`. Common frequency strings include 'D' for
2613+
daily, 'M' for monthly, 'Y' for yearly, etc.
2614+
2615+
See Also
2616+
--------
2617+
Period.asfreq : Convert Period to desired frequency, at the start or end
2618+
of the interval.
2619+
period_range : Return a fixed frequency PeriodIndex.
2620+
26102621
Examples
26112622
--------
26122623
>>> pd.Period('2020-01', 'D').freqstr

0 commit comments

Comments
 (0)