sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 aperta il 2 gen 2015

Vedi su GitHub
 (14 commenti) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
builder:htmlhelp wantedtype:bug

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 13g 10h) (8 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga il modulo di dominio Python in Sphinx, in particolare come vengono elaborati i nomi dei parametri in autodoc e nelle trasformazioni di docutils. Esamina file come sphinx/domains/python.py per la gestione dei nomi dei parametri con underscore finali. Verifica se il problema risiede nell'analisi delle firme o nel rendering HTML. Rivedi i commenti esistenti per eventuali indicazioni sulla causa principale.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
PythonSphinx basicsParameter parsing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40