type is_dtype_equal

[MarcoGorelli]

• Closes #xxxx (Replace xxxx with the Github issue number)
• Tests added: Please use assert_type() to assert the type of any return value

There's already a test for this one using assert_type;

pandas-stubs/tests/test_api_types.py

Lines 125 to 126 in feebd47

	def test_is_dtype_equal() -> None:
	check(assert_type(api.is_dtype_equal("i4", np.int8), bool), bool)

the function just wasn't typed

[Dr-Irv]

In the stubs, we don't include type definitions for methods that are not documented. In this case, is_dtype_equal() is not documented, so I'd prefer to just delete the line from the stubs.

On the other hand, if you think it should be documented, then you can raise an issue in the pandas repo, and we make a decision about this PR after the doc issue is resolved.

[MarcoGorelli]

I'd prefer to just delete the line from the stubs.

sure thing, always happy to delete code

[Dr-Irv]

We have references to is_dtype_equal() in pandas-stubs\api\types\__init__.pyi and pandas-stubs\core\dtypes\api.pyi that should be removed as well.

[Dr-Irv]

UGH. Now that I see that this is used in a test (this one is copied from the pandas source), I think we need to open an issue in pandas about documenting this. I'll do that, and keep this PR on hold.

[Dr-Irv]

Created pandas-dev/pandas#60905

[Dr-Irv]

@MarcoGorelli ok to change this from draft - it will get documented

[Dr-Irv]

@MarcoGorelli pinging you again about whether you want to take this out of draft status

[MarcoGorelli]

sure, thanks - so, undraft for now and then we type it once it's documented?

[Dr-Irv]

sure, thanks - so, undraft for now and then we type it once it's documented?

Sorry - my mistake. Since we decided to document it, let's type it for now, which was the original PR here.

[MarcoGorelli]

sure, done, thanks!

[Dr-Irv]

thanks @MarcoGorelli