plotly / plotly/plotly.py

[mkdocs] No types or annotations for parameters

Offen
#5,408 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug P1
Vorherrschende Sprache
Python
Sterne
18.8k
Forks
2.8k
Ø Merge
16 Std. 26 Min.
Gemergte PRs (30 T.)
21

Beschreibung

  • Functions who include parameters in their docstring that are not explicitly written out in the function signature encounter a "Parameter '...' does not appear in the function signature" warning.
    • func(self, *args, **kwargs): all params in docstring raise warnings
  • Any parameters who do not have a type annotation (except **kwargs and any parameter in the function signature) raises a "No types or annotations for parameters ['parameter_name']"
    • engine (deprecated) : str does not render correctly on markdown causing missing type annotation error
    • annotation_* doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die dokumentierten Fälle für *args/**kwargs, die veraltete engine-Option und annotation_* im MkDocs-Dokumentations-Rendering-Pfad zu reproduzieren. Verfolge, wie Parameternamen und Annotationen geparst und gerendert werden, und überprüfe anschließend, dass gültige Parameter keine Warnungen mehr erzeugen und ihre Typen in Markdown korrekt angezeigt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.