diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 6df5d00d62afb..0aee8cd546d47 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -85,27 +85,17 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then MSG='Partially validate docstrings (RT02)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT02 --ignore_functions \ - pandas.Series.align \ - pandas.Series.dt.total_seconds \ - pandas.Series.cat.rename_categories \ - pandas.Series.cat.reorder_categories \ - pandas.Series.cat.add_categories \ - pandas.Series.cat.remove_categories \ - pandas.Series.cat.remove_unused_categories \ pandas.Index.all \ pandas.Index.any \ pandas.MultiIndex.drop \ pandas.DatetimeIndex.to_pydatetime \ pandas.TimedeltaIndex.to_pytimedelta \ - pandas.core.groupby.SeriesGroupBy.apply \ - pandas.core.groupby.DataFrameGroupBy.apply \ pandas.io.formats.style.Styler.export \ pandas.api.extensions.ExtensionArray.astype \ pandas.api.extensions.ExtensionArray.dropna \ pandas.api.extensions.ExtensionArray.isna \ pandas.api.extensions.ExtensionArray.repeat \ - pandas.api.extensions.ExtensionArray.unique \ - pandas.DataFrame.align + pandas.api.extensions.ExtensionArray.unique RET=$(($RET + $?)) ; echo $MSG "DONE" fi diff --git a/pandas/core/arrays/timedeltas.py b/pandas/core/arrays/timedeltas.py index ac4e8934570ce..1371472af34f8 100644 --- a/pandas/core/arrays/timedeltas.py +++ b/pandas/core/arrays/timedeltas.py @@ -726,7 +726,7 @@ def total_seconds(self) -> npt.NDArray[np.float64]: Returns ------- - seconds : [ndarray, Float64Index, Series] + ndarray, Float64Index or Series When the calling object is a TimedeltaArray, the return type is ndarray. When the calling object is a TimedeltaIndex, the return type is a Float64Index. When the calling object diff --git a/pandas/core/frame.py b/pandas/core/frame.py index ebd4b278b79ca..26c8ab7d04749 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -11018,7 +11018,7 @@ def to_period( Returns ------- - DataFrame: + DataFrame The DataFrame has a PeriodIndex. Examples diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 700601cb4f024..d16446bbdf256 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -9123,7 +9123,7 @@ def align( Returns ------- - (left, right) : ({klass}, type of other) + tuple of ({klass}, type of other) Aligned objects. Examples diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index 431b23023b094..3f9da11f70db7 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -174,7 +174,7 @@ class providing the base-class of operations. Returns ------- - applied : Series or DataFrame + Series or DataFrame See Also -------- diff --git a/pandas/util/_decorators.py b/pandas/util/_decorators.py index 571c065c53351..4a382f7984971 100644 --- a/pandas/util/_decorators.py +++ b/pandas/util/_decorators.py @@ -228,7 +228,7 @@ def _format_argument_list(allow_args: list[str]) -> str: Returns ------- - s : str + str The substring describing the argument list in best way to be inserted to the warning message.