Skip to content

Commit

Permalink
Fix doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
edtechre committed Dec 14, 2023
1 parent 454b712 commit 405fec1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/pybroker/scope.py
Original file line number Diff line number Diff line change
Expand Up @@ -751,7 +751,7 @@ def get_signals(
ind_scope: IndicatorScope,
pred_scope: PredictionScope,
) -> dict[str, pd.DataFrame]:
"""Retrieves dictionary of :class:`pandas.DataFrame`s
"""Retrieves dictionary of :class:`pandas.DataFrame`\ s
containing bar data, indicator data, and model predictions for each symbol.
"""
static_scope = StaticScope.instance()
Expand Down
6 changes: 3 additions & 3 deletions src/pybroker/strategy.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ def backtest_executions(
executions.
Returns:
Dictionary of :class:`pandas.DataFrame`s containing bar data,
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``.
"""
Expand Down Expand Up @@ -774,8 +774,8 @@ class TestResult:
metrics: Evaluation metrics.
metrics_df: :class:`pandas.DataFrame` of evaluation metrics.
bootstrap: Randomized bootstrap evaluation metrics.
signals: Dictionary of :class:`pandas.DataFrame`s containing bar data,
indicator data, and model predictions for each symbol when
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``.
"""

Expand Down

0 comments on commit 405fec1

Please sign in to comment.