sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 ouverte le 2 janv. 2015

Voir sur GitHub
 (14 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
builder:htmlhelp wantedtype:bug

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 13j 10h) (8 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.

Guide contributeur

Direction de recherche
Étudiez le module de domaine Python dans Sphinx, en particulier comment les noms de paramètres sont traités dans autodoc et les transformations docutils. Examinez des fichiers tels que sphinx/domains/python.py pour la gestion des noms de paramètres avec des traits de soulignement en suffixe. Vérifiez si le problème se situe dans l'analyse des signatures ou dans le rendu HTML. Passez en revue les commentaires existants pour toute indication sur la cause racine.
Stack technique
python
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
PythonSphinx basicsParameter parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40