diff options
| author | Hameer Abbasi <hameerabbasi@yahoo.com> | 2019-06-17 12:20:12 +0200 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@gmail.com> | 2019-07-02 19:19:36 -0700 |
| commit | 1002da8e9946517772e8a218902807e3973d774c (patch) | |
| tree | 5158bd4de153d130d04d26da744ee0d64cc4d93f /doc | |
| parent | 9bad7778f056f86324789a6350e4d1c0028cf115 (diff) | |
| download | numpy-1002da8e9946517772e8a218902807e3973d774c.tar.gz | |
Address feedback by @rgommers.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/neps/nep-template.rst | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/neps/nep-template.rst b/doc/neps/nep-template.rst index b2092c057..d675049d0 100644 --- a/doc/neps/nep-template.rst +++ b/doc/neps/nep-template.rst @@ -13,16 +13,23 @@ Abstract The abstract should be a short description of what the NEP will achieve. -Motivation ----------- +Motivation and Scope +-------------------- This section describes the need for the NEP. It should describe the existing -problem, who it affects, what it is trying to solve, and why. +problem, who it affects, what it is trying to solve, and why. This section +should explicitly address the scope and requirements of the proposed change. + +Detailed description +-------------------- + +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, intended use-cases and psuedo-code describing its use. -Literature Review ------------------ +Related Work +------------ 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 |