diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 0aee8cd546d47..b22f19faff9da 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -79,23 +79,8 @@ fi ### DOCSTRINGS ### if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then - MSG='Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG - $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06 - RET=$(($RET + $?)) ; echo $MSG "DONE" - - MSG='Partially validate docstrings (RT02)' ; echo $MSG - $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT02 --ignore_functions \ - pandas.Index.all \ - pandas.Index.any \ - pandas.MultiIndex.drop \ - pandas.DatetimeIndex.to_pydatetime \ - pandas.TimedeltaIndex.to_pytimedelta \ - 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 + MSG='Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT02, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG + $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06 RET=$(($RET + $?)) ; echo $MSG "DONE" fi diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 4497583f60d71..c261a41e1e77e 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -566,7 +566,7 @@ def astype(self, dtype: AstypeArg, copy: bool = True) -> ArrayLike: Returns ------- - array : np.ndarray or ExtensionArray + np.ndarray or pandas.api.extensions.ExtensionArray An ExtensionArray if dtype is ExtensionDtype, Otherwise a NumPy ndarray with 'dtype' for its dtype. """ @@ -600,7 +600,7 @@ def isna(self) -> np.ndarray | ExtensionArraySupportsAnyAll: Returns ------- - na_values : Union[np.ndarray, ExtensionArray] + numpy.ndarray or pandas.api.extensions.ExtensionArray In most cases, this should return a NumPy ndarray. For exceptional cases like ``SparseArray``, where returning an ndarray would be expensive, an ExtensionArray may be @@ -819,7 +819,7 @@ def dropna(self: ExtensionArrayT) -> ExtensionArrayT: Returns ------- - valid : ExtensionArray + pandas.api.extensions.ExtensionArray """ # error: Unsupported operand type for ~ ("ExtensionArray") return self[~self.isna()] # type: ignore[operator] @@ -880,7 +880,7 @@ def unique(self: ExtensionArrayT) -> ExtensionArrayT: Returns ------- - uniques : ExtensionArray + pandas.api.extensions.ExtensionArray """ uniques = unique(self.astype(object)) return self._from_sequence(uniques, dtype=self.dtype) @@ -1088,7 +1088,7 @@ def factorize( Returns ------- - repeated_array : %(klass)s + %(klass)s Newly created %(klass)s with repeated elements. See Also diff --git a/pandas/core/arrays/datetimes.py b/pandas/core/arrays/datetimes.py index 53d02e92946d9..d570a8822649a 100644 --- a/pandas/core/arrays/datetimes.py +++ b/pandas/core/arrays/datetimes.py @@ -1067,7 +1067,7 @@ def to_pydatetime(self) -> npt.NDArray[np.object_]: Returns ------- - datetimes : ndarray[object] + numpy.ndarray """ return ints_to_pydatetime(self.asi8, tz=self.tz, reso=self._creso) diff --git a/pandas/core/arrays/timedeltas.py b/pandas/core/arrays/timedeltas.py index 1371472af34f8..1a2b9728f80a1 100644 --- a/pandas/core/arrays/timedeltas.py +++ b/pandas/core/arrays/timedeltas.py @@ -781,7 +781,7 @@ def to_pytimedelta(self) -> npt.NDArray[np.object_]: Returns ------- - timedeltas : ndarray[object] + numpy.ndarray """ return ints_to_pytimedelta(self._ndarray) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index bc8087db7b49b..4d2e4758817be 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -6680,7 +6680,7 @@ def any(self, *args, **kwargs): Returns ------- - any : bool or array-like (if axis is specified) + bool or array-like (if axis is specified) A single element array-like may be converted to bool. See Also @@ -6724,7 +6724,7 @@ def all(self, *args, **kwargs): Returns ------- - all : bool or array-like (if axis is specified) + bool or array-like (if axis is specified) A single element array-like may be converted to bool. See Also diff --git a/pandas/core/indexes/multi.py b/pandas/core/indexes/multi.py index f7fb6799d2376..d7fba354ceead 100644 --- a/pandas/core/indexes/multi.py +++ b/pandas/core/indexes/multi.py @@ -2164,7 +2164,7 @@ def drop( # type: ignore[override] Returns ------- - dropped : MultiIndex + MultiIndex """ if level is not None: return self._drop_from_level(codes, level, errors) diff --git a/pandas/core/strings/accessor.py b/pandas/core/strings/accessor.py index a9b3816b41774..a232d1dd77da5 100644 --- a/pandas/core/strings/accessor.py +++ b/pandas/core/strings/accessor.py @@ -1479,7 +1479,7 @@ def repeat(self, repeats): Returns ------- - Series or Index of object + Series or pandas.Index Series or Index of repeated string objects specified by input parameter repeats. diff --git a/pandas/io/formats/style.py b/pandas/io/formats/style.py index dd361809e197c..442f2ab72a1e2 100644 --- a/pandas/io/formats/style.py +++ b/pandas/io/formats/style.py @@ -2035,7 +2035,7 @@ def export(self) -> dict[str, Any]: Returns ------- - styles : dict + dict See Also --------