python / python/typing

Spec: PEP leftovers in the spec for literals

Offen Anfängerfreundlich
#2,355 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic: typing spec
Vorherrschende Sprache
Python
Sterne
1.8k
Forks
302
Ø Merge
23 Std.
Gemergte PRs (30 T.)
8

Beschreibung

There are some sections in the spec for literals that made sense as a rationale or look into the future in the PEP, but should be removed in the spec for conciseness, clarity, and consistency:

  • An (incomplete) list of illegal parameters for Literal. Since this immediately succeeds a positive, exclusive list of what parameters are allowed, this is just fluff and I believe the whole section should just be removed.
  • The next section is titled "Parameters at runtime" and details implementation details for Literal. These seem unnecessary for the typing spec and are in danger of getting desynched with the actual implementation.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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

Öffne die Spezifikation für Literale und suche die im Issue erwähnten Abschnitte zu ungültigen Parametern und Parametern zur Laufzeit. Entferne die Abschnitte zu Begründung und Implementierungsdetails, wobei die normative Beschreibung präzise bleibt, und überprüfe anschließend die gerenderte Spezifikation, um zu bestätigen, dass der umgebende Inhalt weiterhin klar verständlich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
75/100

Neue Issues direkt in Ihr Postfach

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