From 1af4b676b74f50a2c66803da2dfea0c81eb57967 Mon Sep 17 00:00:00 2001 From: ivonastojanovic <80911834+ivonastojanovic@users.noreply.github.com> Date: Sun, 4 Aug 2024 15:48:49 +0000 Subject: [PATCH] DOC: Add 'See Also' for pandas.api.types.is_sparse --- ci/code_checks.sh | 1 - pandas/core/dtypes/common.py | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index ebcc99100be70..7d7d3ec48576b 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -296,7 +296,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" \ diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index cd1d5366d6a08..96f22c90fd591 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -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.