diff options
| author | Ralf Gommers <ralf.gommers@gmail.com> | 2019-07-02 19:27:09 -0700 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@gmail.com> | 2019-07-02 19:27:09 -0700 |
| commit | 582f071bcbf73e8db9aa9df6acb69e6ec33318ca (patch) | |
| tree | 5d5cea3685602ef7b25cfde0e741f79e16305688 /doc | |
| parent | 1002da8e9946517772e8a218902807e3973d774c (diff) | |
| download | numpy-582f071bcbf73e8db9aa9df6acb69e6ec33318ca.tar.gz | |
DOC: minor tweak to content and formatting of NEP template.
Removes a duplicate sentence and overlap between the "Motivation and Scope"
and "Detailed implementation" sections.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/neps/nep-template.rst | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/neps/nep-template.rst b/doc/neps/nep-template.rst index d675049d0..2b49ec709 100644 --- a/doc/neps/nep-template.rst +++ b/doc/neps/nep-template.rst @@ -8,25 +8,29 @@ NEP Template and Instructions :Created: <date created on, in yyyy-mm-dd format> :Resolution: <url> (required for Accepted | Rejected | Withdrawn) + Abstract -------- The abstract should be a short description of what the NEP will achieve. + 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. This section -should explicitly address the scope and requirements of the proposed change. +This section describes the need for the proposed change. It should describe +the existing problem, who it affects, what it is trying to solve, and why. +This section should explicitly address the scope of and key requirements for +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. +This section should provide a detailed description of the proposed change. +It should include examples of how the new functionality would be used, +intended use-cases and pseudo-code illustrating its use. + Related Work ------------ @@ -35,18 +39,20 @@ 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 -------------- This section lists the major steps required to implement the NEP. Where possible, it should be noted where one step is dependent on another, and which -steps may be optionally omitted. Where it makes sense, each step should -include a link related pull requests as the implementation progresses. +steps may be optionally omitted. Where it makes sense, each step should +include a link to related pull requests as the implementation progresses. 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 ---------------------- |