Inconsistencies in PEP 1 regarding number assignment

未关闭 适合新手
#5,064 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
65/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
documentation

调研方向

阅读 peps.python.org/pep-0001 中的 PEP 1,重点关注 issue 中确定的“PEP editors”、“Submitting a PEP”、“Discussing a PEP”和“PEP header preamble”部分。将每处相关内容与当前的编号申请工作流进行比较,然后统一更新措辞,并验证渲染后的 PEP 1 不再描述过时的编号分配步骤。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
reStructuredText
星标
5k
派生
1.8k
平均合并
2 天 4 小时
30 天内合并 PR
25

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

python/peps 的其他 Issue

查看 python/peps 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。