NXEP X — 模板和说明#
- 作者:
<作者的真实姓名列表,可选地包括电子邮件地址>
- 状态:
<草稿 | 活动 | 已接受 | 已推迟 | 已拒绝 | 已撤回 | 最终 | 已取代>
- 类型:
<标准追踪 | 流程>
- 创建日期:
<创建日期,yyyy-mm-dd格式>
- 决议:
<url> (Accepted | Rejected | Withdrawn 状态必需)
摘要#
摘要应简要描述本 NXEP 将实现的目标。
请注意,标题中的“—”是长破折号,而不是短横线“-”。
动机和范围#
本节描述了提出这项变更的必要性。它应说明现有问题、受影响的对象、试图解决的问题以及原因。本节应明确阐述拟议变更的范围和关键要求。
用法和影响#
本节描述了 NetworkX 用户将如何使用本 NXEP 中描述的功能。它应主要包含如果没有接受和实现本 NXEP 则不可能实现的示例代码,以及拟议变更将对生态系统产生的影响。本节应从 NetworkX 用户的角度来撰写,并说明它将为用户带来的益处;因此,它仅在需要解释功能时才应包含实现细节。
向后兼容性#
本节描述了本 NXEP 破坏向后兼容性的方面。
邮件列表帖子将包含本 NXEP 直至并包括本节的内容。其目的是为那些不关心详细技术讨论,但可能对例如用法和影响等方面持有意见的用户提供一个高层概要。
详细描述#
本节应详细描述拟议的变更。它应包括新功能如何使用的示例、预期的用例以及说明其用法的伪代码。
实现#
本节列出了实现本 NXEP 所需的主要步骤。在可能的情况下,应说明哪些步骤依赖于其他步骤,以及哪些步骤可以可选地省略。在合理的情况下,随着实现的进展,每个步骤都应包含指向相关拉取请求的链接。
任何包含本 NXEP 相关工作的拉取请求或开发分支都应从这里链接。(如果分阶段实现更合理,则不需要在单个拉取请求中实现一个 NXEP)。
替代方案#
如果曾有解决同一问题的替代方案,应在此处讨论,并说明选择当前方法的原因。
讨论#
本节可能只是一个包含有关本 NXEP 的任何讨论链接的列表。
这包括邮件列表讨论串或相关的 GitHub Issue 的链接。