sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

开放

#519 创建于 2015年1月2日

 (14 条评论) (0 个反应) (0 位负责人)Python (1,985 个派生)batch import
builder:htmlhelp wantedtype:bug

仓库指标

星标
 (5,625 个星标)
PR 合并指标
 (平均合并 10天 11小时) (30 天内合并 11 个 PR)

描述

When documenting Python parameters with trailing underscores:

#!python

def example(str_):
    """Notice that the parameter `str_` has a trailing underscore.

    :param str_: Unfortunately, it gets dropped in the resulting HTML.
    """

The resulting HTML documentation completely omits the trailing underscore.


贡献者指南