NEP X — 模板和说明#

作者:

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

状态:

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

类型:

<标准跟踪 | 流程>

创建:

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

决议:

<url>（对于已接受 | 已拒绝 | 已撤回 是必需的）

摘要#

摘要应该是对 NEP 将要实现的目标的简短描述。

请注意，标题中的 — 是一个长破折号，而不是 -。

动机和范围#

本节描述了对提议变更的需求。它应该描述现有的问题，谁受到影响，它试图解决什么，以及为什么。本节应明确说明提议变更的范围和关键要求。

使用和影响#

本节描述了 NumPy 用户将如何使用本 NEP 中描述的功能。它主要应包含代码示例，这些示例如果没有接受和实施本 NEP，将无法实现，以及提议变更将对生态系统产生的影响。本节应从 NumPy 用户的角度撰写，以及它将为他们提供的益处；因此，它应仅在有必要解释功能时才包含实现细节。

向后兼容性#

本节描述了 NEP 如何破坏向后兼容性。

邮件列表帖子将包含 NEP，包括本节。它的目的是为那些对技术细节不感兴趣的用户提供一个高级摘要，但他们可能对例如使用和影响方面有意见。

详细描述#

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

实现#

本节列出了实现 NEP 所需的主要步骤。如果可能，应注意一个步骤是否依赖于另一个步骤，以及哪些步骤可以被选择性地省略。在有意义的地方，每个步骤都应包含指向相关拉取请求的链接，因为实现正在进行中。

任何包含此 NEP 工作的拉取请求或开发分支都应在此处链接。（如果将 NEP 以离散阶段实施更合理，则 NEP 不需要在一个拉取请求中实施）。

替代方案#

如果有任何其他解决方案可以解决相同的问题，它们应在此处讨论，并附上对所选方法的理由。

讨论#

本节可能只是一份项目符号列表，包括指向任何关于 NEP 的讨论的链接。

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

参考文献和脚注#

本页内容