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

[Dr-Irv]

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

[rhshadrach]

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

[wheeleha]

take

[Dr-Irv]

dev meeting 2/26/2025 - agreed to document

[wheeleha]

dev meeting 2/26/2025 - agreed to document

Are you documenting this?

[Dr-Irv]

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]

take