Skip to content

Commit

Permalink
DOC: add PR01,SA01 for pandas.api.indexers.FixedForwardWindowIndexer
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 committed May 9, 2024
1 parent 37e07ff commit aca9f17
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion pandas/core/indexers/objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,27 @@ def get_window_bounds(

class FixedForwardWindowIndexer(BaseIndexer):
"""
Create window boundaries for fixed-length windows that include the current row.
Creates window boundaries for fixed-length windows that include the current row.
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.
api.indexers.VariableWindowIndexer : Calculate window bounds based on
variable-sized windows.
Examples
--------
Expand Down

0 comments on commit aca9f17

Please sign in to comment.