NXEP X-模板和说明#
- 作者
<作者的真实姓名和可选的电子邮件地址列表>
- 状态
<草案|有效|接受|延期|拒绝|撤回|最终|被取代>
- 类型
<标准跟踪|过程>
- 创建
<创建日期,yyyy-mm-dd格式>
- 分辨率
<url>(接受|拒绝|撤销需要)
摘要#
摘要应该是对NXEP将实现什么的简短描述。
注意,标题中的-是一个加长的破折号,而不是-。
动机和范围#
本节描述了提议变更的必要性。它应该描述存在的问题,它影响了谁,它试图解决什么,为什么。本节应明确说明拟议变更的范围和关键要求。
使用和影响#
本节介绍NetworkX的用户将如何使用本NXEP中介绍的功能。它应该主要由代码示例组成,如果不接受和实现这个NXEP,这些代码示例是不可能的,以及拟议的更改将对生态系统产生的影响。本部分应从NetworkX用户的角度编写,以及它将为他们提供的好处;因此,只有在必要时才应包括实施细节,以解释功能。
向后兼容性#
本节介绍NXEP打破向后兼容性的方法。
邮件列表帖子将包含本节之前的NXEP。它的目的是为那些对详细的技术讨论不感兴趣,但可能对使用和影响有意见的用户提供一个高层次的摘要。
详细描述#
本节应详细说明提议的变更。它应该包括如何使用新功能的示例、预期的用例和说明其使用的伪代码。
实施#
本节列出了实现NXEP所需的主要步骤。在可能的情况下,应注意一个步骤依赖于另一个步骤,以及哪些步骤可以选择性地省略。在有意义的情况下,每个步骤都应该包括一个到实现过程中的相关请求的链接。
任何包含此NXEP工作的请求或开发分支都应该从这里链接到。(如果在离散阶段实现NXEP是有意义的,则不需要在单个请求中实现NXEP)。
选择#
如果有任何解决同一问题的替代方案,应在这里讨论,并说明所选方法的合理性。
讨论#
本节可能只是一个项目符号列表,其中包含有关NXEP的任何讨论的链接:
这包括到邮件列表线程或相关GitHub问题的链接。