File tree 2 files changed +21
-13
lines changed
2 files changed +21
-13
lines changed Original file line number Diff line number Diff line change @@ -77,7 +77,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
77
77
-i " pandas.DataFrame.plot PR02,SA01" \
78
78
-i " pandas.Grouper PR02" \
79
79
-i " pandas.IntervalIndex.left GL08" \
80
- -i " pandas.IntervalIndex.set_closed RT03,SA01" \
81
80
-i " pandas.MultiIndex PR01" \
82
81
-i " pandas.MultiIndex.append PR07,SA01" \
83
82
-i " pandas.MultiIndex.copy PR07,RT03,SA01" \
@@ -395,7 +394,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
395
394
-i " pandas.arrays.IntervalArray.length SA01" \
396
395
-i " pandas.arrays.IntervalArray.mid SA01" \
397
396
-i " pandas.arrays.IntervalArray.right SA01" \
398
- -i " pandas.arrays.IntervalArray.set_closed RT03,SA01" \
399
397
-i " pandas.arrays.NumpyExtensionArray SA01" \
400
398
-i " pandas.arrays.SparseArray PR07,SA01" \
401
399
-i " pandas.arrays.TimedeltaArray PR07,SA01" \
Original file line number Diff line number Diff line change @@ -1436,28 +1436,38 @@ def closed(self) -> IntervalClosedType:
1436
1436
"""
1437
1437
)
1438
1438
1439
- @Appender (
1440
- _interval_shared_docs ["set_closed" ]
1441
- % {
1442
- "klass" : "IntervalArray" ,
1443
- "examples" : textwrap .dedent (
1444
- """\
1439
+ def set_closed (self , closed : IntervalClosedType ) -> Self :
1440
+ """
1441
+ Return an identical IntervalArray closed on the specified side.
1442
+
1443
+ Parameters
1444
+ ----------
1445
+ closed : {'left', 'right', 'both', 'neither'}
1446
+ Whether the intervals are closed on the left-side, right-side, both
1447
+ or neither.
1448
+
1449
+ Returns
1450
+ -------
1451
+ IntervalArray
1452
+ A new IntervalArray with the specified side closures.
1453
+
1454
+ See Also
1455
+ --------
1456
+ IntervalArray.closed : Returns inclusive side of the Interval.
1457
+ arrays.IntervalArray.closed : Returns inclusive side of the IntervalArray.
1458
+
1445
1459
Examples
1446
1460
--------
1447
1461
>>> index = pd.arrays.IntervalArray.from_breaks(range(4))
1448
1462
>>> index
1449
1463
<IntervalArray>
1450
1464
[(0, 1], (1, 2], (2, 3]]
1451
1465
Length: 3, dtype: interval[int64, right]
1452
- >>> index.set_closed(' both' )
1466
+ >>> index.set_closed(" both" )
1453
1467
<IntervalArray>
1454
1468
[[0, 1], [1, 2], [2, 3]]
1455
1469
Length: 3, dtype: interval[int64, both]
1456
1470
"""
1457
- ),
1458
- }
1459
- )
1460
- def set_closed (self , closed : IntervalClosedType ) -> Self :
1461
1471
if closed not in VALID_CLOSED :
1462
1472
msg = f"invalid option for 'closed': { closed } "
1463
1473
raise ValueError (msg )
You can’t perform that action at this time.
0 commit comments