From abc0c887714dfa47a03f2a2004739d2055d89749 Mon Sep 17 00:00:00 2001
From: luenensc <peter.luenenschloss@ufz.de>
Date: Wed, 21 Feb 2024 12:21:28 +0100
Subject: [PATCH] typos and stuff
---
saqc/funcs/constants.py | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/saqc/funcs/constants.py b/saqc/funcs/constants.py
index e0c6d5de0..b8dc7badd 100644
--- a/saqc/funcs/constants.py
+++ b/saqc/funcs/constants.py
@@ -54,13 +54,13 @@ class ConstantsMixin:
window :
Size of the moving window. This determines the number of observations used
for calculating the absolute change per window.
- Each window will be of either of a fixed number of periods (integer defined window),
+ Each window will either contain a fixed number of periods (integer defined window),
or will have a fixed temporal extension (offset defined window).
min_periods :
Minimum number of observations in window required to generate
- a flag. This is only to exclude underpopulated *offset* defined windows from
- flagging.
+ a flag. This can be used to exclude underpopulated *offset* defined windows from
+ flagging. (Integer defined windows will always contain exactly *window* samples).
Must be an integer greater or equal `2`, because a
single value would always be considered constant.
Defaults to `2`.
--
GitLab