Skip to content

DOC: fix SA01,ES01 for pandas.Period.freqstr #59661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2024
Merged

DOC: fix SA01,ES01 for pandas.Period.freqstr #59661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.NA SA01" \
-i "pandas.NaT SA01" \
-i "pandas.Period.freq GL08" \
-i "pandas.Period.freqstr SA01" \
-i "pandas.Period.ordinal GL08" \
-i "pandas.Period.strftime PR01,SA01" \
-i "pandas.Period.to_timestamp SA01" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/_libs/tslibs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2607,6 +2607,17 @@ cdef class _Period(PeriodMixin):
"""
Return a string representation of the frequency.

This property provides the frequency string associated with the `Period`
object. The frequency string describes the granularity of the time span
represented by the `Period`. Common frequency strings include 'D' for
daily, 'M' for monthly, 'Y' for yearly, etc.

See Also
--------
Period.asfreq : Convert Period to desired frequency, at the start or end
of the interval.
period_range : Return a fixed frequency PeriodIndex.

Examples
--------
>>> pd.Period('2020-01', 'D').freqstr
Expand Down
Loading