python / python/mypy

Apply soft word wrap also to notes when using --pretty

Offen
#7,453 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature priority-1-normal topic-usability
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

We only wrap errors, not notes with --pretty. Notes require special care because they contain function signatures (e.g. for overloads and protocols). It would be great to also nicely fit them to terminal width, for example:

        def [T <: SomeBound] meth(self, one_argument: T, other_argument: T) -> List[T]: ...

may become

        def [T <: SomeBound] meth(self,
                                  one_argument: T,
                                  other_argument: T) -> List[T]: ...

This is a follow-up for https://github.com/python/mypy/pull/7440

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, den Ausgabepfad von --pretty zu finden, der Fehler umschließt, und ermittle, wie Hinweise mit Funktionssignaturen formatiert werden. Prüfe, wie dort die Terminalbreite behandelt wird, und verifiziere anschließend, dass Hinweise umgebrochen werden, ohne ihre Signaturstruktur zu beschädigen, und dass die Beispielausgabe in die angeforderte Breite passt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
cli, developer-experience
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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