docs(qav3): refine docstring

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

diff --git a/quickadapter/user_data/strategies/QuickAdapterV3.py b/quickadapter/user_data/strategies/QuickAdapterV3.py
index f2c05aafcfd402e38c86108f75a700dc79a57f83..2b98df4ece7505f14b34e3ffafe6c6f3235531cd 100644 (file)
--- 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)