From 522bce8e4b900db90db9b48ade965adbfaee74ca Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Thu, 19 Mar 2020 16:46:28 +0000 Subject: [PATCH] CLN: Update docstring decorator from Appender to doc --- pandas/core/arrays/numpy_.py | 4 ++-- pandas/core/indexes/extension.py | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pandas/core/arrays/numpy_.py b/pandas/core/arrays/numpy_.py index e8333606ec54c..3058e1d6073f3 100644 --- a/pandas/core/arrays/numpy_.py +++ b/pandas/core/arrays/numpy_.py @@ -6,7 +6,7 @@ from pandas._libs import lib from pandas.compat.numpy import function as nv -from pandas.util._decorators import Appender +from pandas.util._decorators import doc from pandas.util._validators import validate_fillna_kwargs from pandas.core.dtypes.dtypes import ExtensionDtype @@ -449,7 +449,7 @@ def to_numpy( return result - @Appender(ExtensionArray.searchsorted.__doc__) + @doc(ExtensionArray.searchsorted) def searchsorted(self, value, side="left", sorter=None): return searchsorted(self.to_numpy(), value, side=side, sorter=sorter) diff --git a/pandas/core/indexes/extension.py b/pandas/core/indexes/extension.py index 6851aeec0ca40..f38a4fb83c64f 100644 --- a/pandas/core/indexes/extension.py +++ b/pandas/core/indexes/extension.py @@ -7,7 +7,7 @@ from pandas.compat.numpy import function as nv from pandas.errors import AbstractMethodError -from pandas.util._decorators import Appender, cache_readonly +from pandas.util._decorators import cache_readonly, doc from pandas.core.dtypes.common import ( ensure_platform_int, @@ -231,7 +231,7 @@ def __array__(self, dtype=None) -> np.ndarray: def _get_engine_target(self) -> np.ndarray: return self._data._values_for_argsort() - @Appender(Index.dropna.__doc__) + @doc(Index.dropna) def dropna(self, how="any"): if how not in ("any", "all"): raise ValueError(f"invalid how option: {how}") @@ -253,7 +253,7 @@ def _concat_same_dtype(self, to_concat, name): arr = type(self._data)._concat_same_type(to_concat) return type(self)._simple_new(arr, name=name) - @Appender(Index.take.__doc__) + @doc(Index.take) def take(self, indices, axis=0, allow_fill=True, fill_value=None, **kwargs): nv.validate_take(tuple(), kwargs) indices = ensure_platform_int(indices) @@ -283,7 +283,7 @@ def _get_unique_index(self, dropna=False): result = result[~result.isna()] return self._shallow_copy(result) - @Appender(Index.map.__doc__) + @doc(Index.map) def map(self, mapper, na_action=None): # Try to run function on index first, and then on elements of index # Especially important for group-by functionality @@ -300,7 +300,7 @@ def map(self, mapper, na_action=None): except Exception: return self.astype(object).map(mapper) - @Appender(Index.astype.__doc__) + @doc(Index.astype) def astype(self, dtype, copy=True): if is_dtype_equal(self.dtype, dtype) and copy is False: # Ensure that self.astype(self.dtype) is self