DOC: Enforce Numpy Docstring Validation for pandas.IntervalDtype.subt…

…ype (#58522) * DOC: add SA01 for pandas.IntervalDtype.subtype * DOC: remove SA01 for pandas.IntervalDtype.subtype
pandas-dev · May 2, 2024 · ad42520 · ad42520
1 parent b2cde72
commit ad42520
Show file tree

Hide file tree

Showing 2 changed files with 4 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.subtype SA01" \
         -i "pandas.IntervalIndex.closed SA01" \
         -i "pandas.IntervalIndex.contains RT03" \
         -i "pandas.IntervalIndex.get_loc PR07,RT03,SA01" \

diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py
@@ -1311,6 +1311,10 @@ def subtype(self):
         """
         The dtype of the Interval bounds.
 
+        See Also
+        --------
+        IntervalDtype: An ExtensionDtype for Interval data.
+
         Examples
         --------
         >>> dtype = pd.IntervalDtype(subtype="int64", closed="both")