Commit e9cc36f

committed

DOC: Fix pdoc3-references in lib.compute_stats

1 parent 77f4c46 commit e9cc36fCopy full SHA for e9cc36f

File tree

-2

lines changed

-2

lines changed

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -174,8 +174,9 @@ def compute_stats(`
`174`	`174`	`"""`
`175`	`175`	`(Re-)compute strategy performance metrics.`
`176`	`176`
`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.
`179`	`180`	`trades` can be a dataframe subset of `stats._trades` (e.g. only long trades).
`180`	`181`	You can also tune `risk_free_rate`, used in calculation of Sharpe and Sortino ratios.
`181`	`182`

Comments

(0)