python / python/peps

Inconsistencies in PEP 1 regarding number assignment

オープン 初心者向け
#5,064 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
reStructuredText
スター
5k
フォーク
1.8k
平均マージ
2日 4時間
マージ済み PR(30日)
25

説明

#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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

peps.python.org/pep-0001 の PEP 1 を読み、issue で特定されている「PEP editors」、「Submitting a PEP」、「Discussing a PEP」、「PEP header preamble」の各セクションに注目してください。各記述を現在の番号取得ワークフローと比較し、その後、文言を一貫するように更新して、レンダリングされた PEP 1 が古い割り当て手順をもはや説明していないことを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
65/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。