ranaroussi / quantstats

Missing module/function docstring PY-D0003
Documentation
Minor
12 occurrences in this check
Docstring missing for _embed_figure
1658        iDisplay(iHTML(jscode))
1659
1660
1661def _embed_figure(figfiles, figfmt):1662    if isinstance(figfiles, list):
1663        embed_string = "\n"
1664        for figfile in figfiles:
Docstring missing for _open_html
1643        iDisplay(iHTML(jscode.replace("{{filename}}", filename)))
1644
1645
1646def _open_html(html):1647    jscode = _regex.sub(
1648        " +",
1649        " ",
Docstring missing for _download_html
1623    return obj
1624
1625
1626def _download_html(html, filename="quantstats-tearsheet.html"):1627    jscode = _regex.sub(
1628        " +",
1629        " ",
Docstring missing for _html_table
1609    return dd_stats.T
1610
1611
1612def _html_table(obj, showindex="default"):1613    obj = _tabulate(
1614        obj, headers="keys", tablefmt="html", floatfmt=".2f", showindex=showindex
1615    )
Docstring missing for _calc_dd
1498            )
1499
1500
1501def _calc_dd(df, display=True, as_pct=False):1502    dd = _stats.to_drawdown_series(df)
1503    dd_info = _stats.drawdown_details(dd)
1504
Docstring missing for plots
1229    return metrics
1230
1231
1232def plots(1233    returns,
1234    benchmark=None,
1235    grayscale=False,
Docstring missing for metrics
 715    )
 716
 717
 718def metrics( 719    returns,
 720    benchmark=None,
 721    rf=0.0,
Docstring missing for basic
 637    )
 638
 639
 640def basic( 641    returns,
 642    benchmark=None,
 643    rf=0.0,
Docstring missing for full
 488        f.write(tpl)
 489
 490
 491def full( 492    returns,
 493    benchmark=None,
 494    rf=0.0,
Docstring missing for html
  51    return returns, benchmark
  52
  53
  54def html(  55    returns,
  56    benchmark=None,
  57    rf=0.0,
Docstring missing for _match_dates
  40    return periods_per_year, half_year
  41
  42
  43def _match_dates(returns, benchmark):  44    if isinstance(returns, _pd.DataFrame):
  45        loc = max(returns[returns.columns[0]].ne(0).idxmax(), benchmark.ne(0).idxmax())
  46    else:
Docstring missing for _get_trading_periods
  35    from IPython.core.display import display as iDisplay, HTML as iHTML
  36
  37
  38def _get_trading_periods(periods_per_year=252):  39    half_year = _ceil(periods_per_year / 2)
  40    return periods_per_year, half_year
  41