NEP X — 模板和说明#

作者:

<作者的真实姓名列表，可选填电子邮件地址>

状态:

<草案 | 活动 | 已接受 | 已推迟 | 已拒绝 | 已撤回 | 最终 | 已取代>

类型:

<标准跟踪 | 流程>

创建时间:

<创建日期，格式为 yyyy-mm-dd>

解决时间:

<url> (已接受 | 已拒绝 | 已撤回 时必填)

摘要#

摘要应简要描述 NEP 将实现的目标。

请注意，标题中的 — 是长破折号，不是连字符 -。

动机与范围#

本节描述了提议更改的必要性。应描述现有问题、受影响的人群、试图解决的问题以及原因。本节应明确说明提议更改的范围和关键要求。

用法与影响#

本节描述了 NumPy 用户将如何使用本 NEP 中描述的功能。主要应包含在接受和实现本 NEP 之前不可能实现的示例代码，以及提议更改对生态系统的影响。本节应从 NumPy 用户的角度进行撰写，说明其将为用户带来的好处；因此，除非为了解释功能而有必要，否则应仅包含实现细节。

向后兼容性#

本节描述了 NEP 破坏向后兼容性的方式。

邮件列表帖子将包含 NEP 直至本节为止的内容。其目的是为不感兴趣详细技术讨论的用户提供一个高层摘要，但可能对例如使用和影响有意见。

详细描述#

本节应提供对提议更改的详细描述。应包含新功能如何使用的示例、预期用例以及说明其使用的伪代码。

实现#

本节列出了实现 NEP 所需的主要步骤。如果可能，应注明一个步骤对另一个步骤的依赖性，以及哪些步骤可以省略。在合理的情况下，每个步骤都应包含指向相关拉取请求的链接，以随着实现的进展。

包含此 NEP 工作的所有拉取请求或开发分支均应从此链接。 （如果可以通过离散阶段实现 NEP，则无需将 NEP 实现为一个拉取请求）。

替代方案#

如果存在解决同一问题的替代方案，应在此处进行讨论，并说明选择该方法的理由。

讨论#

本节可能仅是一个包含 NEP 相关讨论链接的列表。

  • 这包括邮件列表线程或相关 GitHub 问题的链接。

参考文献和脚注#