diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 64bcde23ce34d..e457a4678e30e 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -368,7 +368,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \ -i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \ -i "pandas.api.extensions.ExtensionArray.view SA01" \ - -i "pandas.api.indexers.BaseIndexer PR01,SA01" \ -i "pandas.api.indexers.FixedForwardWindowIndexer PR01,SA01" \ -i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \ -i "pandas.api.interchange.from_dataframe RT03,SA01" \ diff --git a/pandas/core/indexers/objects.py b/pandas/core/indexers/objects.py index d108f840a1b4f..5912f78c95c73 100644 --- a/pandas/core/indexers/objects.py +++ b/pandas/core/indexers/objects.py @@ -48,6 +48,25 @@ class BaseIndexer: """ Base class for window bounds calculations. + Parameters + ---------- + index_array : np.ndarray, default None + Array-like structure representing the indices for the data points. + If None, the default indices are assumed. This can be useful for + handling non-uniform indices in data, such as in time series + with irregular timestamps. + window_size : int, default 0 + Size of the moving window. This is the number of observations used + for calculating the statistic. The default is to consider all + observations within the window. + **kwargs + Additional keyword arguments passed to the subclass's methods. + + See Also + -------- + DataFrame.rolling : Provides rolling window calculations on dataframe. + Series.rolling : Provides rolling window calculations on series. + Examples -------- >>> from pandas.api.indexers import BaseIndexer