From c1ee54b646da36334f26aab4a9bbf4e57bc81c8b Mon Sep 17 00:00:00 2001 From: Domagoj Fijan <50439291+DomFijan@users.noreply.github.com> Date: Fri, 19 Jul 2024 12:10:58 -0400 Subject: [PATCH] Update docstrings Co-authored-by: Jen Bradley <55467578+janbridley@users.noreply.github.com> --- dupin/data/aggregate.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dupin/data/aggregate.py b/dupin/data/aggregate.py index 07a8972..66f1e71 100644 --- a/dupin/data/aggregate.py +++ b/dupin/data/aggregate.py @@ -29,7 +29,7 @@ class SignalAggregator: This class can be used to create appropriate data structures for use in analyzing a whole trajectory with offline methods or iteratively analyzing for online use. See the `compute` and `accumulate` methods for - usage. The signal is stored in a deque, which allows for signal to be of + usage. The signal is stored in a deque, which maintains a signal of constant length by forgetting earlier values. This is useful for online detection. Full signal length can be achieved by setting `max_deque_length` to `None`.