DOC: fix PR07 and SA01 issue for Index: copy and get_slice_bound (pan…

…das-dev#58443) * DOC: fix PR07 and SA01 issue for Index: copy and get_slice_bound * ficing line to long error
natmokval · Apr 26, 2024 · a1fc8e8 · a1fc8e8
1 parent 13771ab
commit a1fc8e8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -105,15 +105,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Grouper PR02" \
         -i "pandas.Index PR07" \
         -i "pandas.Index.append PR07,RT03,SA01" \
-        -i "pandas.Index.copy PR07,SA01" \
         -i "pandas.Index.difference PR07,RT03,SA01" \
         -i "pandas.Index.drop PR07,SA01" \
         -i "pandas.Index.duplicated RT03" \
         -i "pandas.Index.get_indexer PR07,SA01" \
         -i "pandas.Index.get_indexer_for PR01,SA01" \
         -i "pandas.Index.get_indexer_non_unique PR07,SA01" \
         -i "pandas.Index.get_loc PR07,RT03,SA01" \
-        -i "pandas.Index.get_slice_bound PR07" \
         -i "pandas.Index.identical PR01,SA01" \
         -i "pandas.Index.insert PR07,RT03,SA01" \
         -i "pandas.Index.intersection PR07,RT03,SA01" \

diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py
@@ -1262,12 +1262,19 @@ def copy(
         name : Label, optional
             Set name for new object.
         deep : bool, default False
+            If True attempts to make a deep copy of the Index.
+                Else makes a shallow copy.
 
         Returns
         -------
         Index
             Index refer to new object which is a copy of this object.
 
+        See Also
+        --------
+        Index.delete: Make new Index with passed location(-s) deleted.
+        Index.drop: Make new Index with passed list of labels deleted.
+
         Notes
         -----
         In most cases, there should be no functional difference from using
@@ -6398,7 +6405,10 @@ def get_slice_bound(self, label, side: Literal["left", "right"]) -> int:
         Parameters
         ----------
         label : object
+            The label for which to calculate the slice bound.
         side : {'left', 'right'}
+            if 'left' return leftmost position of given label.
+            if 'right' return one-past-the-rightmost position of given label.
 
         Returns
         -------