diff options
| author | Hameer Abbasi <einstein.edison@gmail.com> | 2019-10-17 16:32:35 +0200 |
|---|---|---|
| committer | Hameer Abbasi <einstein.edison@gmail.com> | 2019-10-24 15:14:25 +0200 |
| commit | 37ca4f8d98c9c6aafedb90029d2de357c7dfefee (patch) | |
| tree | 1c20907f3359ad508cd7b445e27cc03037940756 /doc | |
| parent | 1185880f153c5bbc2081a17121617beb588cfb1f (diff) | |
| download | numpy-37ca4f8d98c9c6aafedb90029d2de357c7dfefee.tar.gz | |
DOC: Edit NEP procedure for better discussion
This commit changes the NEP template and the NEP procedure to allow for
better discussion, both on the mailing list as well
as the pull request itself.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/neps/nep-0000.rst | 9 | ||||
| -rw-r--r-- | doc/neps/nep-template.rst | 25 |
2 files changed, 26 insertions, 8 deletions
diff --git a/doc/neps/nep-0000.rst b/doc/neps/nep-0000.rst index 97b69279b..090c4850e 100644 --- a/doc/neps/nep-0000.rst +++ b/doc/neps/nep-0000.rst @@ -76,8 +76,13 @@ where ``<n>`` is an appropriately assigned four-digit number (e.g., ``nep-0000.rst``). The draft must use the :doc:`nep-template` file. Once the PR is in place, the NEP should be announced on the mailing -list for discussion (comments on the PR itself should be restricted to -minor editorial and technical fixes). +list for discussion. Discussion about implementation details will take place +on the pull request, but once editorial issues are solved, the PR should be +merged, even if with draft status. The mailing list e-mail will contain the NEP +upto the section titled "Backward compatibility", so as to make it digestible +to a wide audience. The mailing list discussion is intended to target +end-users, and thus, discussion on the proposed usage and possible impact +should take place on the mailing list. At the earliest convenience, the PR should be merged (regardless of whether it is accepted during discussion). Additional PRs may be made diff --git a/doc/neps/nep-template.rst b/doc/neps/nep-template.rst index c3d34ea46..55a872ca9 100644 --- a/doc/neps/nep-template.rst +++ b/doc/neps/nep-template.rst @@ -24,6 +24,25 @@ 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. +Usage and Impact +---------------- + +This section describes how users of NumPy will use features described in this +NEP. It should be comprised mainly of code examples that wouldn't be possible +without acceptance and implementation of this NEP, as well as the impact the +proposed changes would have on the ecosystem. This section should be written +from the perspective of the users of NumPy, and the benefits it will provide +them; and as such, it should include implementation details only if +necessary to explain the functionality. + +Backward compatibility +---------------------- + +This section describes the ways in which the NEP breaks backward compatibility. + +The mailing list post will contain the NEP up to and including this section. +This is to avoid losing users who are not interested in implementation details +and instead focus the discussion on usage and impact of the intended features. Detailed description -------------------- @@ -54,12 +73,6 @@ 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 ----------------------- - -This section describes the ways in which the NEP breaks backward compatibility. - - Alternatives ------------ |