sphinx-doc/sphinx
Trailing underscores in parameter names are dropped
Ouverte
#519 ouverte le 2 janv. 2015
builder:htmlhelp wantedtype:bug
Métriques du dépôt
- Stars
- (5 625 étoiles)
- Métriques de merge PR
- (Merge moyen 10j 11h) (11 PRs mergées en 30 j)
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.
- Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/519
- Originally reported by: Anonymous
- Originally created at: 2010-09-03T16:55:51.617