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.

贡献者指南

研究方向
研究 Sphinx 中的 Python 领域模块，特别是 autodoc 和 docutils 转换中如何处理参数名称。查看 sphinx/domains/python.py 等文件，了解如何处理带有尾随下划线的参数名。检查问题是在签名解析阶段还是在 HTML 渲染阶段。查看现有评论，寻找任何关于根本原因的线索。
技术栈
python
领域
documentation
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
PythonSphinx basicsParameter parsing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40