Skip to content

DOC: add an example to PeriodIndex.to_timestamp to clarify the behavior in case len(index)<3 #57384

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 3 commits into from
Feb 15, 2024
Merged

DOC: add an example to PeriodIndex.to_timestamp to clarify the behavior in case len(index)<3 #57384

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7ff4ca
add an example to PeriodIndex.to_timestamp
natmokval Feb 12, 2024
a2dc46a
correct to_timestamp docs, add an example
natmokval Feb 14, 2024
760d555
correct the wording in to_timestamp docstring
natmokval Feb 15, 2024
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
6 changes: 6 additions & 0 deletions pandas/core/arrays/period.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,12 @@ def to_timestamp(self, freq=None, how: str = "start") -> DatetimeArray:
>>> idx.to_timestamp()
DatetimeIndex(['2023-01-01', '2023-02-01', '2023-03-01'],
dtype='datetime64[ns]', freq='MS')

We can not infer the frequency if len(index) < 3:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No big deal, but I'd personally phrase this as The frequency will not be inferred if the index contains less than three elements:. I had to read the current version couple of times to understand it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the comment @datapythonista, I corrected docstring as you suggested. I also added a new example to emphasize importance values of index to be strictly monotonic.


>>> idx = pd.PeriodIndex(["2023-01", "2023-02"], freq="M")
>>> idx.to_timestamp()
DatetimeIndex(['2023-01-01', '2023-02-01'], dtype='datetime64[ns]', freq=None)
"""
from pandas.core.arrays import DatetimeArray

Expand Down