Skip to content

DOC: Fix docstrings api.types.pandas_dtype #60319

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

Merged
merged 3 commits into from
Nov 15, 2024
Merged

DOC: Fix docstrings api.types.pandas_dtype #60319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
296adda
add api.types.pandas_dtype PR07, RT03, SA01 docstrings
invalid-email-address Nov 15, 2024
4d544ff
remove from code_checks.sh
invalid-email-address Nov 15, 2024
ecc8669
edit see also
invalid-email-address Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timestamp.resolution PR02" \
-i "pandas.Timestamp.tzinfo GL08" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
-i "pandas.arrays.IntegerArray SA01" \
-i "pandas.arrays.IntervalArray.length SA01" \
Expand Down
8 changes: 7 additions & 1 deletion pandas/core/dtypes/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1785,16 +1785,22 @@ def pandas_dtype(dtype) -> DtypeObj:

Parameters
----------
dtype : object to be converted
dtype : object
The object to be converted into a dtype.

Returns
-------
np.dtype or a pandas dtype
The converted dtype, which can be either a numpy dtype or a pandas dtype.

Raises
------
TypeError if not a dtype

See Also
--------
api.types.is_dtype : Return true if the condition is satisfied for the arr_or_dtype.

Examples
--------
>>> pd.api.types.pandas_dtype(int)
Expand Down