From c7c0bf4b9e5854f8b9a021d2255c4f45fb8e90bb Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 15:10:26 +0530 Subject: [PATCH 1/3] DOC: add PR07,RT03 in pandas.Index.slice_indexer --- pandas/core/indexes/base.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 2bf0aca31449e..fe3303889fe35 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -6330,10 +6330,12 @@ def slice_indexer( end : label, default None If None, defaults to the end. step : int, default None + If None, defaults to 1. Returns ------- slice + A slice object. Raises ------ From 8f812d04ced25027e2cece41ff3288f08b736472 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 17:22:51 +0530 Subject: [PATCH 2/3] DOC: add SA01 in pandas.Index.slice_indexer --- pandas/core/indexes/base.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index fe3303889fe35..dfacd71471d84 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -6342,9 +6342,14 @@ def slice_indexer( KeyError : If key does not exist, or key is not unique and index is not ordered. + See Also + -------- + Index.slice_locs : Computes slice locations for input labels. + Index.get_slice_bound : Retrieves slice bound that corresponds to given label. + Notes ----- - This function assumes that the data is sorted, so use at your own peril + This function assumes that the data is sorted, so use at your own peril. Examples -------- From 85110e7682dd7c7f817af3b84e03e6d948c8ce31 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 17:23:22 +0530 Subject: [PATCH 3/3] DOC: remove pandas.Index.slice_indexer --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 161047197ff6f..c1172e1f771d8 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -101,7 +101,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Index.names GL08" \ -i "pandas.Index.putmask PR01,RT03" \ -i "pandas.Index.ravel PR01,RT03" \ - -i "pandas.Index.slice_indexer PR07,RT03,SA01" \ -i "pandas.Index.str PR01,SA01" \ -i "pandas.Index.take PR01,PR07" \ -i "pandas.Index.view GL08" \