-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: add api.types.is_dtype_equal
into document
#61394
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.
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
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
caa4e9c
Doc: add api.types.is_dtype_equal into document
chilin0525 45b8212
Doc: add parameter description, import of example and see also sectio…
chilin0525 6bd99c4
Update pandas/core/dtypes/common.py
chilin0525 7e499a4
Update pandas/core/dtypes/common.py
chilin0525 c88a79d
Update pandas/core/dtypes/common.py
chilin0525 7ca7023
Doc: fix doc format
chilin0525 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -655,24 +655,38 @@ def is_dtype_equal(source, target) -> bool: | |
|
||
Parameters | ||
---------- | ||
source : The first dtype to compare | ||
target : The second dtype to compare | ||
source : dtype | ||
The first dtype to compare | ||
target : dtype | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Resolved in 7ca7023. |
||
The second dtype to compare | ||
chilin0525 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Returns | ||
------- | ||
boolean | ||
Whether or not the two dtypes are equal. | ||
|
||
See Also | ||
-------- | ||
pandas.api.types.is_categorical_dtype : Check whether the provided array or dtype | ||
chilin0525 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
is of the Categorical dtype. | ||
pandas.api.types.is_string_dtype : Check whether the provided array or dtype | ||
is of the string dtype. | ||
pandas.api.types.is_object_dtype : Check whether an array-like or dtype is of the | ||
object dtype. | ||
|
||
Examples | ||
-------- | ||
>>> from pandas.api.types import is_dtype_equal | ||
>>> is_dtype_equal(int, float) | ||
False | ||
>>> is_dtype_equal("int", int) | ||
True | ||
>>> is_dtype_equal(object, "category") | ||
False | ||
>>> from pandas.core.dtypes.dtypes import CategoricalDtype | ||
>>> is_dtype_equal(CategoricalDtype(), "category") | ||
True | ||
>>> from pandas.core.dtypes.dtypes import DatetimeTZDtype | ||
>>> is_dtype_equal(DatetimeTZDtype(tz="UTC"), "datetime64") | ||
False | ||
""" | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.