DOC: fix SA05 errors in docstrings for pandas.PeriodIndex.asfreq, arr… (#57408)

DOC: fix SA05 errors in docstrings for pandas.PeriodIndex.asfreq, arrays - ArrowStringArray, StringArray

Co-authored-by: William Joshua King <[email protected]>

Author: williamking1221

ci/code_checks.sh

@@ -1155,9 +1155,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
 
     MSG='Partially validate docstrings (SA05)' ;  echo $MSG
     $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \
-        pandas.PeriodIndex.asfreq\
-        pandas.arrays.ArrowStringArray\
-        pandas.arrays.StringArray\
         pandas.core.groupby.DataFrameGroupBy.first\
         pandas.core.groupby.DataFrameGroupBy.last\
         pandas.core.groupby.SeriesGroupBy.first\

pandas/core/arrays/string_.py

@@ -315,7 +315,7 @@ class StringArray(BaseStringArray, NumpyExtensionArray):  # type: ignore[misc]
 
     See Also
     --------
-    :func:`pandas.array`
+    :func:`array`
         The recommended function for creating a StringArray.
     Series.str
         The string methods are available on Series backed by

pandas/core/arrays/string_arrow.py

@@ -105,7 +105,7 @@ class ArrowStringArray(ObjectStringArrayMixin, ArrowExtensionArray, BaseStringAr
 
     See Also
     --------
-    :func:`pandas.array`
+    :func:`array`
         The recommended function for creating a ArrowStringArray.
     Series.str
         The string methods are available on Series backed by

pandas/core/indexes/period.py

@@ -185,7 +185,7 @@ def _resolution_obj(self) -> Resolution:
 
     @doc(
         PeriodArray.asfreq,
-        other="pandas.arrays.PeriodArray",
+        other="arrays.PeriodArray",
         other_name="PeriodArray",
         **_shared_doc_kwargs,
     )