Skip to content

Commit e9cc36f

Browse files
committed
DOC: Fix pdoc3-references in lib.compute_stats
1 parent 77f4c46 commit e9cc36f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

backtesting/lib.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,9 @@ def compute_stats(
174174
"""
175175
(Re-)compute strategy performance metrics.
176176
177-
`stats` is the statistics series as returned by `Backtest.run()`.
178-
`data` is OHLC data as passed to the `Backtest` the `stats` were obtained in.
177+
`stats` is the statistics series as returned by `backtesting.backtesting.Backtest.run()`.
178+
`data` is OHLC data as passed to the `backtesting.backtesting.Backtest`
179+
the `stats` were obtained in.
179180
`trades` can be a dataframe subset of `stats._trades` (e.g. only long trades).
180181
You can also tune `risk_free_rate`, used in calculation of Sharpe and Sortino ratios.
181182

0 commit comments

Comments
 (0)