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