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 合併指標
 (平均合併 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.


貢獻者指南