Skip to content

DOC: fix SA01 for pandas.PeriodDtype #59674

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 31, 2024
Merged

DOC: fix SA01 for pandas.PeriodDtype #59674

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 @@ -75,7 +75,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Period.ordinal GL08" \
-i "pandas.Period.strftime PR01,SA01" \
-i "pandas.Period.to_timestamp SA01" \
-i "pandas.PeriodDtype SA01" \
-i "pandas.PeriodDtype.freq SA01" \
-i "pandas.RangeIndex PR07" \
-i "pandas.RangeIndex.from_range PR01,SA01" \
Expand Down
8 changes: 8 additions & 0 deletions pandas/core/dtypes/dtypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,6 +986,14 @@ class PeriodDtype(PeriodDtypeBase, PandasExtensionDtype):
-------
None

See Also
--------
Period : Represents a single time period.
PeriodIndex : Immutable index for period data.
date_range : Return a fixed frequency DatetimeIndex.
Series : One-dimensional array with axis labels.
DataFrame : Two-dimensional, size-mutable, potentially heterogeneous tabular data.

Examples
--------
>>> pd.PeriodDtype(freq="D")
Expand Down
Loading