From: Jérôme Benoit Date: Wed, 19 Mar 2025 00:50:18 +0000 (+0100) Subject: docs(qav3): refine docstring X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=594441098c16230acaff961599e2b63c51332cc1;p=freqai-strategies.git docs(qav3): refine docstring Signed-off-by: Jérôme Benoit --- 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)