Skip to content

Commit b1a637e

Browse files
tuhinsharma121pmhatre1
authored andcommitted
DOC: Enforce Numpy Docstring Validation for pandas.IntervalDtype (pandas-dev#58521)
* DOC: add PR01,SA01 in pandas.IntervalDtype * DOC: remove PR01,SA01 in pandas.IntervalDtype
1 parent de8f752 commit b1a637e

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9191
-i "pandas.Interval.left SA01" \
9292
-i "pandas.Interval.mid SA01" \
9393
-i "pandas.Interval.right SA01" \
94-
-i "pandas.IntervalDtype PR01,SA01" \
9594
-i "pandas.IntervalDtype.subtype SA01" \
9695
-i "pandas.IntervalIndex.closed SA01" \
9796
-i "pandas.IntervalIndex.contains RT03" \

pandas/core/dtypes/dtypes.py

+7
Original file line numberDiff line numberDiff line change
@@ -1195,6 +1195,9 @@ class IntervalDtype(PandasExtensionDtype):
11951195
----------
11961196
subtype : str, np.dtype
11971197
The dtype of the Interval bounds.
1198+
closed : {'right', 'left', 'both', 'neither'}, default 'right'
1199+
Whether the interval is closed on the left-side, right-side, both or
1200+
neither. See the Notes for more detailed explanation.
11981201
11991202
Attributes
12001203
----------
@@ -1204,6 +1207,10 @@ class IntervalDtype(PandasExtensionDtype):
12041207
-------
12051208
None
12061209
1210+
See Also
1211+
--------
1212+
PeriodDtype : An ExtensionDtype for Period data.
1213+
12071214
Examples
12081215
--------
12091216
>>> pd.IntervalDtype(subtype="int64", closed="both")

0 commit comments

Comments
 (0)