sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 建立於 2015年1月2日

在 GitHub 查看
 (14 留言) (0 反應) (0 負責人)Python (5,625 star) (1,985 fork)batch import
builder:htmlhelp wantedtype:bug

描述

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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
PythonSphinx basicsParameter parsing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Investigate the Python domain module in Sphinx, particularly how parameter names are processed in autodoc and docutils transforms. Look at files such as sphinx/domains/python.py for the handling of parameter names with trailing underscores. Check if the issue is in the parsing of signatures or in the rendering of HTML. Review existing comments for any pointers to the root cause.