Skip to content

DOC: fix EX02 docstring errors for three docstrings #51550

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 2 commits into from
Feb 22, 2023
Merged

DOC: fix EX02 docstring errors for three docstrings #51550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7fab41
updated some dtypes docstrings
phershbe Feb 22, 2023
ab2ead3
deleted comment
phershbe Feb 22, 2023
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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,9 +574,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.api.types.is_datetime64_ns_dtype \
pandas.api.types.is_datetime64tz_dtype \
pandas.api.types.is_integer_dtype \
pandas.api.types.is_interval_dtype \
pandas.api.types.is_period_dtype \
pandas.api.types.is_signed_integer_dtype \
pandas.api.types.is_sparse \
pandas.api.types.is_string_dtype \
pandas.api.types.is_unsigned_integer_dtype \
Expand Down
7 changes: 5 additions & 2 deletions pandas/core/dtypes/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,9 +398,10 @@ def is_period_dtype(arr_or_dtype) -> bool:

Examples
--------
>>> from pandas.core.dtypes.common import is_period_dtype
>>> is_period_dtype(object)
False
>>> is_period_dtype(PeriodDtype(freq="D"))
>>> is_period_dtype(pd.PeriodDtype(freq="D"))
True
>>> is_period_dtype([1, 2, 3])
False
Expand Down Expand Up @@ -434,9 +435,10 @@ def is_interval_dtype(arr_or_dtype) -> bool:

Examples
--------
>>> from pandas.core.dtypes.common import is_interval_dtype
>>> is_interval_dtype(object)
False
>>> is_interval_dtype(IntervalDtype())
>>> is_interval_dtype(pd.IntervalDtype())
True
>>> is_interval_dtype([1, 2, 3])
False
Expand Down Expand Up @@ -727,6 +729,7 @@ def is_signed_integer_dtype(arr_or_dtype) -> bool:

Examples
--------
>>> from pandas.core.dtypes.common import is_signed_integer_dtype
>>> is_signed_integer_dtype(str)
False
>>> is_signed_integer_dtype(int)
Expand Down