Inconsistencies in PEP 1 regarding number assignment

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

Dieses Issue hat noch niemand übernommen.

Bewertung

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

Rechercherichtung

Lies PEP 1 unter peps.python.org/pep-0001 und konzentriere dich auf die in der Issue identifizierten Abschnitte „PEP editors“, „Submitting a PEP“, „Discussing a PEP“ und „PEP header preamble“. Vergleiche jeden Verweis mit dem aktuellen Workflow zum Beanspruchen einer Nummer, aktualisiere anschließend die Formulierung konsistent und verifiziere, dass das gerenderte PEP 1 keine veralteten Schritte zur Zuweisung mehr beschreibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

#3163 updated PEP 1 so the PEP number should be worked out by the author on PR creation, not assigned by an editor once approved.

There are a few places that mention "assign"ing a number and seem a bit inconsistent with this.

  1. In https://peps.python.org/pep-0001/#pep-editors

    The PEP editors are individuals responsible for managing the administrative and editorial aspects of the PEP workflow (e.g. assigning PEP numbers, ...

    A minor one, I can see an argument for leaving it as I guess PEP editors do still "manage" the numbers, but maybe there's a clearer wording.

  2. In https://peps.python.org/pep-0001/#submitting-a-pep

    • Once approved, they will assign your PEP a number.

    Confusing, as the first task in the list is to select a PEP number yourself.

    Developers with write access to the PEP repository may claim PEP numbers directly by creating and committing a new PEP.

    This no longer seems relevant, anyone can claim a pep number.

    Getting a PEP number assigned early can be useful for ease of reference, especially when multiple draft PEPs are being considered at the same time.

    Same with this.

  3. In https://peps.python.org/pep-0001/#discussing-a-pep

    As soon as a PEP number has been assigned and the draft PEP is committed to the PEP repository, a discussion thread for the PEP should be created

    Not really incorrect, but mentioning it seems a bit meaningless now.

    Once the PEP is assigned a number and committed to the PEP repository, substantive issues should generally be discussed on the canonical public thread

    Same here, should just mention "committed to PEP repository".

  4. In https://peps.python.org/pep-0001/#pep-header-preamble

    The Created header records the date that the PEP was assigned a number

    The wording here isn't incorrect, but the change to how numbers are assigned seems to imply that now the "created" date can differ quite significantly from when it is published to https://peps.python.org. It is not clear that this was effect was considered, so I'll create a separate issue to discuss it.

Vorherrschende Sprache
reStructuredText
Sterne
5k
Forks
1.8k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
25

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/peps

Alle Issues in python/peps

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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