From 594441098c16230acaff961599e2b63c51332cc1 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Wed, 19 Mar 2025 01:50:18 +0100 Subject: [PATCH] docs(qav3): refine docstring MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- quickadapter/user_data/strategies/QuickAdapterV3.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/quickadapter/user_data/strategies/QuickAdapterV3.py b/quickadapter/user_data/strategies/QuickAdapterV3.py index f2c05aa..2b98df4 100644 --- a/quickadapter/user_data/strategies/QuickAdapterV3.py +++ b/quickadapter/user_data/strategies/QuickAdapterV3.py @@ -610,10 +610,10 @@ class QuickAdapterV3(IStrategy): def top_change_percent(dataframe: DataFrame, period: int) -> Series: """ - Percentage change of the current close relative to the maximum close price - over the lookback period. + Percentage change of the current close relative to the top close price in previous periods. :param dataframe: DataFrame The original OHLCV dataframe - :param period: int The period to look back (0 = previous candle) + :param period: int The period size to look back + :return: Series The percentage change series """ if period == 0: previous_close = dataframe["close"].shift(1) -- 2.43.0