sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 创建于 2015年1月2日

在 GitHub 查看
 (14 评论) (0 反应) (0 负责人)Python (1,985 fork)batch import
builder:htmlhelp wantedtype:bug

仓库指标

Star
 (5,625 star)
PR 合并指标
 (平均合并 13天 10小时) (30 天内合并 8 个 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.


贡献者指南