NEP X — 模板和说明#
- 作者:
<作者的真实姓名列表以及可选的电子邮件地址>
- 状态:
<草稿 | 活动 | 已接受 | 延迟 | 已拒绝 | 已撤回 | 最终 | 已取代>
- 类型:
<标准跟踪 | 流程>
- 创建:
<创建日期,yyyy-mm-dd格式>
- 决议:
<url>(对于已接受 | 已拒绝 | 已撤回,此项必填)
摘要#
摘要应简要说明NEP将实现的目标。
请注意,标题中的 — 是一个长破折号,而不是 -。
动机和范围#
本节描述了对拟议更改的需求。它应描述现有问题、受影响的人员、试图解决的问题以及原因。本节应明确说明拟议更改的范围和关键要求。
用法和影响#
本节描述了NumPy用户将如何使用本NEP中描述的功能。它主要应包含如果没有接受和实施本NEP则不可能实现的代码示例,以及拟议更改将对生态系统产生的影响。本节应从NumPy用户的角度撰写,并说明它将为他们提供的益处;因此,只有在需要解释功能时才应包含实现细节。
向后兼容性#
本节描述了NEP破坏向后兼容性的方式。
邮件列表帖子将包含NEP直至本节。其目的是为那些对详细技术讨论不感兴趣但可能对例如用法和影响有意见的用户提供高级摘要。
详细说明#
本节应提供对拟议更改的详细说明。它应包含有关如何使用新功能的示例、预期的用例以及说明其使用的伪代码。
实现#
本节列出了实施NEP所需的主要步骤。在可能的情况下,应指出一个步骤依赖于另一个步骤,以及哪些步骤可以可选地省略。在有意义的情况下,每个步骤都应包含在实施过程中与相关拉取请求的链接。
包含此NEP工作的任何拉取请求或开发分支都应从此处链接。(如果将NEP分阶段实施更有意义,则NEP不需要在一个拉取请求中实施)。
替代方案#
如果有任何解决相同问题的替代方案,则应在此处讨论,并说明所选方法的理由。
讨论#
本节可能只是一个项目符号列表,其中包含关于NEP的任何讨论的链接。
这包括邮件列表主题或相关的GitHub问题的链接。
参考文献和脚注#
版权#
本文档已放置在公共领域。[1]