sphinx-doc/sphinx
Trailing underscores in parameter names are dropped
Offen
#519 geöffnet am 02.01.2015
builder:htmlhelp wantedtype:bug
Repository-Metriken
- Stars
- (5.625 Sterne)
- PR-Merge-Metriken
- (Durchschn. Merge 10T 11h) (11 gemergte PRs in 30 T)
Beschreibung
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.
- Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/519
- Originally reported by: Anonymous
- Originally created at: 2010-09-03T16:55:51.617