sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 aberto em 2 de jan. de 2015

Ver no GitHub
 (14 comments) (0 reactions) (0 assignees)Python (1.985 forks)batch import
builder:htmlhelp wantedtype:bug

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 13d 10h) (8 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.

Guia do colaborador

Direção de pesquisa
Investigue o módulo de domínio Python no Sphinx, particularmente como os nomes dos parâmetros são processados no autodoc e nas transformações do docutils. Examine arquivos como sphinx/domains/python.py para o tratamento de nomes de parâmetros com sublinhados à direita. Verifique se o problema está na análise de assinaturas ou na renderização HTML. Revise os comentários existentes em busca de quaisquer indicações sobre a causa raiz.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
PythonSphinx basicsParameter parsing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40