Skip to content

Commit 9690809

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.api.extensions.register_extension_dtype (#58615)
* DOC: add PR01,SA01 for pandas.api.indexers.BaseIndexer * DOC: remove PR01,SA01 for pandas.api.indexers.BaseIndexer
1 parent dd4b872 commit 9690809

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
368368
-i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
369369
-i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
370370
-i "pandas.api.extensions.ExtensionArray.view SA01" \
371-
-i "pandas.api.indexers.BaseIndexer PR01,SA01" \
372371
-i "pandas.api.indexers.FixedForwardWindowIndexer PR01,SA01" \
373372
-i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \
374373
-i "pandas.api.interchange.from_dataframe RT03,SA01" \

pandas/core/indexers/objects.py

+19
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,25 @@ class BaseIndexer:
4848
"""
4949
Base class for window bounds calculations.
5050
51+
Parameters
52+
----------
53+
index_array : np.ndarray, default None
54+
Array-like structure representing the indices for the data points.
55+
If None, the default indices are assumed. This can be useful for
56+
handling non-uniform indices in data, such as in time series
57+
with irregular timestamps.
58+
window_size : int, default 0
59+
Size of the moving window. This is the number of observations used
60+
for calculating the statistic. The default is to consider all
61+
observations within the window.
62+
**kwargs
63+
Additional keyword arguments passed to the subclass's methods.
64+
65+
See Also
66+
--------
67+
DataFrame.rolling : Provides rolling window calculations on dataframe.
68+
Series.rolling : Provides rolling window calculations on series.
69+
5170
Examples
5271
--------
5372
>>> from pandas.api.indexers import BaseIndexer

0 commit comments

Comments
 (0)