From 1317337b6c831023e337c5ca6229778d85d166bb Mon Sep 17 00:00:00 2001 From: Janukan Sivajeyan <28988453+JanukanS@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:58:45 -0700 Subject: [PATCH] Described default centre argument behaviour in rolling functions (#9819) * Described default centre argument behaviour in rolling functions. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- xarray/core/dataarray.py | 3 ++- xarray/core/dataset.py | 3 ++- xarray/core/rolling.py | 6 ++++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index eae11c0c491..f989990bbd4 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -7081,7 +7081,8 @@ def rolling( (otherwise result is NA). The default, None, is equivalent to setting min_periods equal to the size of the window. center : bool or Mapping to int, default: False - Set the labels at the center of the window. + Set the labels at the center of the window. The default, False, + sets the labels at the right edge of the window. **window_kwargs : optional The keyword arguments form of ``dim``. One of dim or window_kwargs must be provided. diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index f96b62f701e..b9f932196ad 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -10728,7 +10728,8 @@ def rolling( (otherwise result is NA). The default, None, is equivalent to setting min_periods equal to the size of the window. center : bool or Mapping to int, default: False - Set the labels at the center of the window. + Set the labels at the center of the window. The default, False, + sets the labels at the right edge of the window. **window_kwargs : optional The keyword arguments form of ``dim``. One of dim or window_kwargs must be provided. diff --git a/xarray/core/rolling.py b/xarray/core/rolling.py index fde87841d32..6186f4dacfe 100644 --- a/xarray/core/rolling.py +++ b/xarray/core/rolling.py @@ -282,7 +282,8 @@ def __init__( (otherwise result is NA). The default, None, is equivalent to setting min_periods equal to the size of the window. center : bool, default: False - Set the labels at the center of the window. + Set the labels at the center of the window. The default, False, + sets the labels at the right edge of the window. Returns ------- @@ -793,7 +794,8 @@ def __init__( (otherwise result is NA). The default, None, is equivalent to setting min_periods equal to the size of the window. center : bool or mapping of hashable to bool, default: False - Set the labels at the center of the window. + Set the labels at the center of the window. The default, False, + sets the labels at the right edge of the window. Returns -------