NXEP X — 模板和说明#

作者:

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

状态:

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

类型:

<标准跟踪 | 过程>

创建日期:

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

决议:

<url>（已接受 | 拒绝 | 撤回时必需）

摘要#

摘要应该是NXEP将实现的内容的简短描述。

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

动机和范围#

本节描述了提议更改的需求。它应描述现有问题，受影响的对象，它试图解决的问题以及原因。本节应明确说明提议更改的范围和关键要求。

使用和影响#

本节描述了NetworkX的用户将如何使用本NXEP中描述的功能。它应主要由代码示例组成，这些示例在没有接受和实施本NXEP的情况下是不可能的，以及提议更改对生态系统的影响。本节应从NetworkX用户的角度编写，并说明它们将提供的好处；因此，只有在必要时才应包含实现细节以解释功能。

向后兼容性#

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

邮件列表帖子将包含NXEP，直到包括本节。其目的是向对详细技术讨论不感兴趣但可能对使用和影响等方面有意见的用户提供高层次摘要。

详细描述#

本节应提供关于提议更改的详细描述。它应包括新功能的使用示例、预期用例和说明其使用的伪代码示例。

相关工作#

本节应列出相关和/或类似的技术，可能是其他库中的。它不需要是全面的，只需列出先前和相关艺术的主要示例。

实施#

本节列出了实施NXEP所需的主要步骤。在可能的情况下，应指出一个步骤依赖于另一个步骤，以及哪些步骤可以选择性地省略。在有意义的情况下，每个步骤应包括一个链接，以便在实施进展中链接到相关的拉取请求。

任何包含对本NXEP的工作的拉取请求或开发分支应从这里链接过去。（如果有意义将NXEP分阶段实施，则不需要在单个拉取请求中实施它）。

替代方案#

如果有任何解决同一问题的替代方案，它们应在此处讨论，并说明所选择方法的理由。

讨论#

这一部分可能只是一个包含指向任何有关 NXEP 讨论的链接的项目列表：

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

On this page