sphinx-doc/sphinx

Trailing underscores in parameter names are dropped

Open

#519 geöffnet am 2. Jan. 2015

Auf GitHub ansehen
 (14 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
builder:htmlhelp wantedtype:bug

Repository-Metriken

Stars
 (5.625 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 13T 10h) (8 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie das Python Domänenmodul in Sphinx, insbesondere wie Parameternamen in autodoc und docutils Transformationen verarbeitet werden. Prüfen Sie Dateien wie sphinx/domains/python.py auf die Behandlung von Parameternamen mit nachgestellten Unterstrichen. Überprüfen Sie, ob das Problem in der Analyse von Signaturen oder im HTML Rendering liegt. Überprüfen Sie vorhandene Kommentare auf Hinweise zur Ursache.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
PythonSphinx basicsParameter parsing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40