NEP X — 範本與說明#
- 作者:
<作者真實姓名列表,可選填電子郵件地址>
- 狀態:
<草稿 | 活躍 | 已接受 | 延遲 | 已拒絕 | 已撤回 | 最終 | 已取代>
- 類型:
<標準追蹤 | 流程>
- 建立日期:
<建立日期,格式為 yyyy-mm-dd>
- 決議:
<網址> (已接受 | 已拒絕 | 已撤回 項目為必填)
摘要#
摘要應簡短描述 NEP 將達成的目標。
請注意,標題中的 — 是長破折號,而非 -。
動機與範圍#
本節描述提出此變更的必要性。應說明現有的問題、影響對象、試圖解決的問題以及原因。本節應明確說明擬議變更的範圍和主要需求。
使用方式與影響#
本節描述 NumPy 使用者將如何使用本 NEP 中描述的功能。內容應主要包含若未接受並實作此 NEP 便不可能實現的程式碼範例,以及擬議變更對生態系統的影響。本節應從 NumPy 使用者的角度撰寫,以及它將為他們帶來的好處;因此,只有在必要時才應包含實作細節以解釋功能。
向後相容性#
本節描述 NEP 破壞向後相容性的方式。
郵寄清單貼文將包含 NEP 直到本節(含)。其目的是為不對詳細技術討論感興趣的使用者提供高階摘要,但這些使用者可能對使用方式和影響等有意見。
詳細描述#
本節應提供擬議變更的詳細描述。應包含新功能將如何使用的範例、預期的使用案例以及說明其用途的虛擬碼。
實作#
本節列出實作 NEP 所需的主要步驟。在可能的情況下,應註明哪個步驟依賴於另一個步驟,以及哪些步驟可以選擇性地省略。在合理的情況下,每個步驟都應包含實作進展時相關的提取請求連結。
任何包含此 NEP 工作的提取請求或開發分支都應從此處連結。(如果分階段實作更合理,則 NEP 不需要放入單個提取請求中實作)。
替代方案#
如果存在任何解決相同問題的替代方案,則應在此處討論,並說明選擇方法的理由。
討論#
本節可能只是一個項目符號列表,包含任何關於 NEP 的討論連結
這包括郵寄清單討論串或相關 GitHub issue 的連結。
參考文獻與註腳#
著作權#
本文件已置於公共領域。[1]