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 (5,625 stars) (1,985 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Trailing underscores in parameter names are dropped · sphinx-doc/sphinx#519 | Good First Issue