python / python/mypy

Better documentation for the HTML report

Offen
#13,495 2 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

This is the only thing I can find in the docs about this HTML report, and it's far from complete. I could find these three questions on Stack Overflow, but none of them have satisfying answers (or answers at all).

I understand that mypy is reporting the presence of expressions of type Any in each line. (Is it? Did I get that right?) But what exactly do the colors mean? Why do lines with @overload always get colored red in my reports? Why do lines with isinstance always get colored yellow?

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 mit der in der Issue verlinkten Dokumentation zum HTML-Bericht über die Kommandozeile und nutze anschließend die drei verlinkten Stack Overflow-Fragen, um die fehlenden Erklärungen zu ermitteln. Dokumentiere, was der Bericht misst, was seine Farben bedeuten und warum Konstrukte wie @overload und isinstance die beobachteten Farben erhalten; abgeschlossen ist die Aufgabe, wenn Benutzer den Bericht interpretieren können, ohne auf unbeantwortete externe Fragen angewiesen zu sein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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