DOC: add SA01 for pandas.api.extensions.ExtensionArray.shape (#58705)

* DOC: add SA01 for pandas.api.extensions.ExtensionArray.shape * DOC: remove SA01 for pandas.api.extensions.ExtensionArray.shape
pandas-dev · May 13, 2024 · 3bbd048 · 3bbd048
1 parent 41c9116
commit 3bbd048
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
@@ -334,7 +334,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.api.extensions.ExtensionArray.nbytes SA01" \
         -i "pandas.api.extensions.ExtensionArray.ndim SA01" \
         -i "pandas.api.extensions.ExtensionArray.ravel RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.shape SA01" \
         -i "pandas.api.extensions.ExtensionArray.shift SA01" \
         -i "pandas.api.extensions.ExtensionArray.take RT03" \
         -i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \

diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py
@@ -610,6 +610,13 @@ def shape(self) -> Shape:
         """
         Return a tuple of the array dimensions.
 
+        See Also
+        --------
+        numpy.ndarray.shape : Similar attribute which returns the shape of an array.
+        DataFrame.shape : Return a tuple representing the dimensionality of the
+            DataFrame.
+        Series.shape : Return a tuple representing the dimensionality of the Series.
+
         Examples
         --------
         >>> arr = pd.array([1, 2, 3])