Skip to content

DOC: Should pandas.api.types.is_dtype_equal() be documented? #60905

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
Dr-Irv opened this issue Feb 10, 2025 · 6 comments · Fixed by #61394
Closed
1 task done

DOC: Should pandas.api.types.is_dtype_equal() be documented? #60905

Dr-Irv opened this issue Feb 10, 2025 · 6 comments · Fixed by #61394
Assignees
@chilin0525 @wheeleha
Labels
Docs Dtype Conversions Unexpected or buggy dtype conversions

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Feb 10, 2025 •
edited by rhshadrach
Loading

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

None: It's not there!

Documentation problem

pandas.api.types.is_dtype_equal() is not documented, but it is used in tests/extension/decimal/array.py which is used as an example ExtensionArray implementation

Suggested fix for documentation

Unsure if we want this in the public API or not, but if so, we ought to fix it.

See pandas-dev/pandas-stubs#1112 for some discussion
@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 10, 2025
This was referenced Feb 10, 2025
Merged
Closed
@rhshadrach
Copy link
Member

I think anything accessible via pandas.api is public, and thus should be documented. This has been in pandas.api since at least 2016.

@rhshadrach rhshadrach added Dtype Conversions Unexpected or buggy dtype conversions Needs Discussion Requires discussion from core team before further action and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 12, 2025
@wheeleha
Copy link

take

@rhshadrach rhshadrach removed the Needs Discussion Requires discussion from core team before further action label Feb 23, 2025
@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Feb 26, 2025

dev meeting 2/26/2025 - agreed to document

@wheeleha
Copy link

dev meeting 2/26/2025 - agreed to document

Are you documenting this?

@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Feb 27, 2025

dev meeting 2/26/2025 - agreed to document

Are you documenting this?

Not me, but we agreed that we want this function to be documented in a PR.

@chilin0525
Copy link
Contributor

take

@chilin0525 chilin0525 mentioned this issue May 3, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chilin0525 chilin0525

@wheeleha wheeleha

Labels
Docs Dtype Conversions Unexpected or buggy dtype conversions
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: add api.types.is_dtype_equal into document chilin0525/pandas
4 participants
@Dr-Irv @chilin0525 @rhshadrach @wheeleha