sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 opened on Jan 2, 2015

View on GitHub
 (14 comments) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
builder:htmlhelp wantedtype:bug

Description

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.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonSphinx basicsParameter parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.