Skip to content

Commit 9b76144

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.IntervalIndex.closed and pandas.arrays.IntervalArray.closed (#58608)
* DOC: add SA01 for pandas.IntervalIndex.closed and pandas.arrays.IntervalArray.closed * DOC: remove SA01 for pandas.IntervalIndex.closed and pandas.arrays.IntervalArray.closed
1 parent 1d03028 commit 9b76144

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7878
-i "pandas.Grouper PR02" \
7979
-i "pandas.Index PR07" \
8080
-i "pandas.Interval PR02" \
81-
-i "pandas.IntervalIndex.closed SA01" \
8281
-i "pandas.IntervalIndex.contains RT03" \
8382
-i "pandas.IntervalIndex.get_loc PR07,RT03,SA01" \
8483
-i "pandas.IntervalIndex.is_non_overlapping_monotonic SA01" \
@@ -417,7 +416,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
417416
-i "pandas.arrays.DatetimeArray SA01" \
418417
-i "pandas.arrays.FloatingArray SA01" \
419418
-i "pandas.arrays.IntegerArray SA01" \
420-
-i "pandas.arrays.IntervalArray.closed SA01" \
421419
-i "pandas.arrays.IntervalArray.contains RT03" \
422420
-i "pandas.arrays.IntervalArray.is_non_overlapping_monotonic SA01" \
423421
-i "pandas.arrays.IntervalArray.left SA01" \

pandas/core/arrays/interval.py

+6
Original file line numberDiff line numberDiff line change
@@ -1389,6 +1389,12 @@ def closed(self) -> IntervalClosedType:
13891389
13901390
Either ``left``, ``right``, ``both`` or ``neither``.
13911391
1392+
See Also
1393+
--------
1394+
IntervalArray.closed : Returns inclusive side of the IntervalArray.
1395+
Interval.closed : Returns inclusive side of the Interval.
1396+
IntervalIndex.closed : Returns inclusive side of the IntervalIndex.
1397+
13921398
Examples
13931399
--------
13941400

0 commit comments

Comments
 (0)