DOC: add RT03,SA01 for pandas.IntervalIndex.set_closed and pandas.arr…

…ays.IntervalArray.set_closed (#58683) * DOC: add RT03,SA01 for pandas.IntervalIndex.set_closed and pandas.arrays.IntervalArray.set_closed * DOC: remove RT03,SA01 for pandas.IntervalIndex.set_closed and pandas.arrays.IntervalArray.set_closed
pandas-dev · May 12, 2024 · 3de26e0 · 3de26e0
1 parent de9ec9f
commit 3de26e0
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 13 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -77,7 +77,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DataFrame.plot PR02,SA01" \
         -i "pandas.Grouper PR02" \
         -i "pandas.IntervalIndex.left GL08" \
-        -i "pandas.IntervalIndex.set_closed RT03,SA01" \
         -i "pandas.MultiIndex PR01" \
         -i "pandas.MultiIndex.append PR07,SA01" \
         -i "pandas.MultiIndex.copy PR07,RT03,SA01" \
@@ -395,7 +394,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.arrays.IntervalArray.length SA01" \
         -i "pandas.arrays.IntervalArray.mid SA01" \
         -i "pandas.arrays.IntervalArray.right SA01" \
-        -i "pandas.arrays.IntervalArray.set_closed RT03,SA01" \
         -i "pandas.arrays.NumpyExtensionArray SA01" \
         -i "pandas.arrays.SparseArray PR07,SA01" \
         -i "pandas.arrays.TimedeltaArray PR07,SA01" \

diff --git a/pandas/core/arrays/interval.py b/pandas/core/arrays/interval.py
@@ -1436,28 +1436,38 @@ def closed(self) -> IntervalClosedType:
         """
     )
 
-    @Appender(
-        _interval_shared_docs["set_closed"]
-        % {
-            "klass": "IntervalArray",
-            "examples": textwrap.dedent(
-                """\
+    def set_closed(self, closed: IntervalClosedType) -> Self:
+        """
+        Return an identical IntervalArray closed on the specified side.
+
+        Parameters
+        ----------
+        closed : {'left', 'right', 'both', 'neither'}
+            Whether the intervals are closed on the left-side, right-side, both
+            or neither.
+
+        Returns
+        -------
+        IntervalArray
+            A new IntervalArray with the specified side closures.
+
+        See Also
+        --------
+        IntervalArray.closed : Returns inclusive side of the Interval.
+        arrays.IntervalArray.closed : Returns inclusive side of the IntervalArray.
+
         Examples
         --------
         >>> index = pd.arrays.IntervalArray.from_breaks(range(4))
         >>> index
         <IntervalArray>
         [(0, 1], (1, 2], (2, 3]]
         Length: 3, dtype: interval[int64, right]
-        >>> index.set_closed('both')
+        >>> index.set_closed("both")
         <IntervalArray>
         [[0, 1], [1, 2], [2, 3]]
         Length: 3, dtype: interval[int64, both]
         """
-            ),
-        }
-    )
-    def set_closed(self, closed: IntervalClosedType) -> Self:
         if closed not in VALID_CLOSED:
             msg = f"invalid option for 'closed': {closed}"
             raise ValueError(msg)