From 5b4b17f5e8dbf45d3dcba13957c81be9bca785f1 Mon Sep 17 00:00:00 2001 From: William Joshua King Date: Tue, 13 Feb 2024 17:15:26 -0500 Subject: [PATCH] DOC: fix SA05 errors in docstrings for pandas.PeriodIndex.asfreq, arrays - ArrowStringArray, StringArray --- ci/code_checks.sh | 3 --- pandas/core/arrays/string_.py | 2 +- pandas/core/arrays/string_arrow.py | 2 +- pandas/core/indexes/period.py | 2 +- 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 39ccf904858d5..d679bf117aeac 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -146,9 +146,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.agg\ pandas.DataFrame.aggregate\ pandas.DataFrame.boxplot\ - pandas.PeriodIndex.asfreq\ - pandas.arrays.ArrowStringArray\ - pandas.arrays.StringArray\ pandas.core.groupby.DataFrameGroupBy.first\ pandas.core.groupby.DataFrameGroupBy.last\ pandas.core.groupby.SeriesGroupBy.first\ diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 5a803c9064db9..1b9f803bafc5d 100644 --- a/pandas/core/arrays/string_.py +++ b/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 diff --git a/pandas/core/arrays/string_arrow.py b/pandas/core/arrays/string_arrow.py index ba02c63c00ce4..fc5ce33d641ee 100644 --- a/pandas/core/arrays/string_arrow.py +++ b/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 diff --git a/pandas/core/indexes/period.py b/pandas/core/indexes/period.py index a7315d40f0236..a970b949750a3 100644 --- a/pandas/core/indexes/period.py +++ b/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, )