Skip to content

DOC: Incorrect deprecation example for is_period_dtype #60542

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

Jump to bottom
Closed
1 task done
tehunter opened this issue Dec 11, 2024 · 0 comments · Fixed by #60543
Closed
1 task done

DOC: Incorrect deprecation example for is_period_dtype #60542

tehunter opened this issue Dec 11, 2024 · 0 comments · Fixed by #60543
Labels
Docs

Comments

@tehunter
Copy link
Contributor

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.api.types.is_period_dtype.html#pandas.api.types.is_period_dtype

Documentation problem

Suggests the user use isinstance(dtype, pd.Period) instead, when they really need to use Use isinstance(dtype, pd.PeriodDtype)

Suggested fix for documentation

Update message to reference correct class
@tehunter tehunter added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Dec 11, 2024
@tehunter tehunter mentioned this issue Dec 11, 2024
Merged
1 task
@rhshadrach rhshadrach removed the Needs Triage Issue that has not been reviewed by a pandas team member label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: fix deprecation message for is_period_dtype tehunter/pandas
2 participants
@tehunter @rhshadrach