diff options
| author | Hameer Abbasi <hameerabbasi@yahoo.com> | 2019-06-12 19:58:35 +0200 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@gmail.com> | 2019-07-02 19:19:36 -0700 |
| commit | 9bad7778f056f86324789a6350e4d1c0028cf115 (patch) | |
| tree | 203a5959d9b4df65e539b3534cce5ad1502bd359 /doc | |
| parent | 8c72036e596eb23286dcabcb4312fafc44c6e691 (diff) | |
| download | numpy-9bad7778f056f86324789a6350e4d1c0028cf115.tar.gz | |
MAINT: Update NEP template.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/neps/nep-template.rst | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/neps/nep-template.rst b/doc/neps/nep-template.rst index e869ebae3..b2092c057 100644 --- a/doc/neps/nep-template.rst +++ b/doc/neps/nep-template.rst @@ -13,15 +13,20 @@ Abstract The abstract should be a short description of what the NEP will achieve. - -Detailed description --------------------- +Motivation +---------- This section describes the need for the NEP. It should describe the existing -problem that it is trying to solve and why this NEP makes the situation better. -It should include examples of how the new functionality would be used and -perhaps some use cases. +problem, who it affects, what it is trying to solve, and why. +It should include examples of how the new functionality would be used, intended +use-cases and psuedo-code describing its use. +Literature Review +----------------- + +This section should list relevant and/or similar technologies, possibly in other +libraries. It does not need to be comprehensive, just list the major examples of +prior and relevant art. Implementation -------------- @@ -35,7 +40,6 @@ Any pull requests or development branches containing work on this NEP should be linked to from here. (A NEP does not need to be implemented in a single pull request if it makes sense to implement it in discrete phases). - Backward compatibility ---------------------- |