sphinx-doc/sphinx
Trailing underscores in parameter names are dropped
Aberta
#519 aberto em 2 de jan. de 2015
builder:htmlhelp wantedtype:bug
Métricas do repositório
- Stars
- (5.625 estrelas)
- Métricas de merge de PR
- (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)
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