diff --git a/docs/resources/images/horizontalAxiRollingExample.png b/docs/resources/images/horizontalAxiRollingExample.png new file mode 100644 index 0000000000000000000000000000000000000000..b5f1dff483e43e6bfc0718f6d6f50c32c0fae312 Binary files /dev/null and b/docs/resources/images/horizontalAxiRollingExample.png differ diff --git a/docs/resources/images/horizontalAxisRollingExample.png.license b/docs/resources/images/horizontalAxisRollingExample.png.license new file mode 100644 index 0000000000000000000000000000000000000000..f8c6bf8cd36fb9a9a0a0dd474407f40908bf5d1f --- /dev/null +++ b/docs/resources/images/horizontalAxisRollingExample.png.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ + +SPDX-License-Identifier: GPL-3.0-or-later \ No newline at end of file diff --git a/saqc/funcs/rolling.py b/saqc/funcs/rolling.py index 327c32f132e1dee4916ca031fc52f1eab51ec683..de872d506ed8046ae356e00a52805eb026af9ddf 100644 --- a/saqc/funcs/rolling.py +++ b/saqc/funcs/rolling.py @@ -64,6 +64,12 @@ class RollingMixin: center : If True, center the rolling window. + + Notes + ----- + .. figure:: /resources/images/horizontalAxisRollingExample.png + + Rolling over multiple variables. """ # HINT: checking in _roll if target and (len(target) > 1) and (len(field) != len(target)): @@ -145,6 +151,7 @@ class RollingMixin: center : If True, center the rolling window. + """ import warnings