Adds doc for TestResult#stops

edtechre · Apr 20, 2024 · 94af0ed · 94af0ed
1 parent 3a8a330
commit 94af0ed
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/pybroker/strategy.py b/src/pybroker/strategy.py
@@ -780,6 +780,8 @@ class TestResult:
         signals: Dictionary of :class:`pandas.DataFrame`\ s containing bar
             data, indicator data, and model predictions for each symbol when
             :attr:`pybroker.config.StrategyConfig.return_signals` is ``True``.
+        stops: :class:`pandas.DataFrame` containing stop data per-bar when
+            :attr:`pybroker.config.StrategyConfig.return_stops` is ``True``.
     """
 
     start_date: datetime