DOC: Enforce Numpy Docstring Validation for pandas.IntervalDtype (#58521

) * DOC: add PR01,SA01 in pandas.IntervalDtype * DOC: remove PR01,SA01 in pandas.IntervalDtype
pandas-dev · May 2, 2024 · 9fee6cf · 9fee6cf
1 parent 9110f7c
commit 9fee6cf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -91,7 +91,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Interval.left SA01" \
         -i "pandas.Interval.mid SA01" \
         -i "pandas.Interval.right SA01" \
-        -i "pandas.IntervalDtype PR01,SA01" \
         -i "pandas.IntervalDtype.subtype SA01" \
         -i "pandas.IntervalIndex.closed SA01" \
         -i "pandas.IntervalIndex.contains RT03" \

diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py
@@ -1195,6 +1195,9 @@ class IntervalDtype(PandasExtensionDtype):
     ----------
     subtype : str, np.dtype
         The dtype of the Interval bounds.
+    closed : {'right', 'left', 'both', 'neither'}, default 'right'
+        Whether the interval is closed on the left-side, right-side, both or
+        neither. See the Notes for more detailed explanation.
 
     Attributes
     ----------
@@ -1204,6 +1207,10 @@ class IntervalDtype(PandasExtensionDtype):
     -------
     None
 
+    See Also
+    --------
+    PeriodDtype : An ExtensionDtype for Period data.
+
     Examples
     --------
     >>> pd.IntervalDtype(subtype="int64", closed="both")