chore: improve docstring

xmatthias · xmatthias · commit 16ef34822299 · 2025-01-13T07:10:54.000+01:00
diff --git a/freqtrade/optimize/backtesting.py b/freqtrade/optimize/backtesting.py
@@ -1417,6 +1417,8 @@ def time_pair_generator(
     ):
         """
         Backtest time and pair generator
+        :returns: generator of (current_time, pair, is_first)
+            where is_first is True for the first pair of each new candle
         """
         current_time = start_date + increment
         self.progress.init_step(
