Add 'See Also' and 'Parameters'

Add 'See Also' and 'Parameters' for VariableOffsetWindowIndexer

Author: ivonastojanovic

ci/code_checks.sh

@@ -267,7 +267,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.VariableOffsetWindowIndexer PR01,SA01" \
         -i "pandas.api.interchange.from_dataframe RT03,SA01" \
         -i "pandas.api.types.is_any_real_numeric_dtype SA01" \
         -i "pandas.api.types.is_bool PR01,SA01" \

pandas/core/indexers/objects.py

@@ -167,6 +167,38 @@ class VariableOffsetWindowIndexer(BaseIndexer):
     """
     Calculate window boundaries based on a non-fixed offset such as a BusinessDay.
 
+    Parameters
+    ----------
+    index_array : np.ndarray, default 0
+        Array-like structure specifying the indices for data points.
+        If not provided, the default index is used. This parameter is
+        especially useful for handling datasets with non-uniform or
+        irregular indices.
+
+    window_size : int, optional, default 0
+        Specifies the number of data points in each window.
+        A value of 0 means the window size is determined dynamically
+        based on the provided `offset` and `index`.
+
+    index : DatetimeIndex, optional
+        The time index that dictates the window boundaries.
+        This should be a `DatetimeIndex` which aligns with the temporal
+        nature of the data.
+
+    offset : BaseOffset, optional
+        A pandas offset object used to calculate the window boundaries.
+        It defines the time-based offset that adjusts the size and
+        position of the windows.
+
+    **kwargs
+        Additional keyword arguments passed to the parent class `BaseIndexer`.
+
+    See Also
+    --------
+    api.indexers.BaseIndexer : Base class for all indexers.
+    DataFrame.rolling : Rolling window calculations on DataFrames.
+    offsets : Module providing various time offset classes.
+
     Examples
     --------
     >>> from pandas.api.indexers import VariableOffsetWindowIndexer