From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Mon, 24 Mar 2025 09:52:27 +0000 (+0100)
Subject: docs(qav3): docstring for ewo
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=e33cbaab104ffc5c653993f5fea570c83b295455;p=freqai-strategies.git

docs(qav3): docstring for ewo

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/quickadapter/user_data/strategies/Utils.py b/quickadapter/user_data/strategies/Utils.py
index 79940e4..84855f1 100644
--- a/quickadapter/user_data/strategies/Utils.py
+++ b/quickadapter/user_data/strategies/Utils.py
@@ -249,6 +249,9 @@ def ewo(
     zero_lag=False,
     normalize=False,
 ) -> pd.Series:
+    """
+    Calculate the Elliott Wave Oscillator (EWO) using two moving averages.
+    """
     price_series = get_price_fn(pricemode)(dataframe)
     ma_fn = get_ma_fn(mamode, zero_lag=zero_lag)
     ma1 = ma_fn(price_series, timeperiod=ma1_length)