Skip to content

DOC: Add 'See Also' for pandas.api.types.is_sparse #59406

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
Aug 5, 2024
Merged

DOC: Add 'See Also' for pandas.api.types.is_sparse #59406

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
1af4b67
DOC: Add 'See Also' for pandas.api.types.is_sparse
ivonastojanovic Aug 4, 2024
9dd51ef
Merge branch 'main' into pandas_api_types_is_sparse_docs
mroeschke Aug 5, 2024
738c277
Merge branch 'main' into pandas_api_types_is_sparse_docs
mroeschke Aug 5, 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 @@ -293,7 +293,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_period_dtype SA01" \
-i "pandas.api.types.is_re PR07,SA01" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.is_sparse SA01" \
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/dtypes/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,10 @@ def is_sparse(arr) -> bool:
bool
Whether or not the array-like is a pandas sparse array.

See Also
--------
api.types.SparseDtype : The dtype object for pandas sparse arrays.

Examples
--------
Returns `True` if the parameter is a 1-D pandas sparse array.
Expand Down
Loading