sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 opened on 2015年1月2日

GitHub で見る
 (14 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
builder:htmlhelp wantedtype:bug

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (平均マージ 10d 11h) (30d で 11 merged PRs)

説明

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.


コントリビューターガイド