DOC: add SA01 for pandas.api.extensions.ExtensionArray.shift (#58785)

pandas-dev · May 19, 2024 · 31c2836 · 31c2836
1 parent 1a6d6eb
commit 31c2836
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
@@ -304,7 +304,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.shift SA01" \
         -i "pandas.api.extensions.ExtensionArray.take RT03" \
         -i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
         -i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \

diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py
@@ -1192,6 +1192,13 @@ def shift(self, periods: int = 1, fill_value: object = None) -> ExtensionArray:
         ExtensionArray
             Shifted.
 
+        See Also
+        --------
+        api.extensions.ExtensionArray.transpose : Return a transposed view on
+            this array.
+        api.extensions.ExtensionArray.factorize : Encode the extension array as an
+            enumerated type.
+
         Notes
         -----
         If ``self`` is empty or ``periods`` is 0, a copy of ``self`` is