diff options
| author | Matti Picus <matti.picus@gmail.com> | 2019-10-24 18:08:04 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-24 18:08:04 +0300 |
| commit | fda559c28c87ce14cb65fce8ad9eb0fdbda4a879 (patch) | |
| tree | cce946e38af6830089f6215504b325e4427fb0b0 /doc/neps | |
| parent | c10d66ab8e153d944dc705434c5733d0e8249926 (diff) | |
| parent | 37ca4f8d98c9c6aafedb90029d2de357c7dfefee (diff) | |
| download | numpy-fda559c28c87ce14cb65fce8ad9eb0fdbda4a879.tar.gz | |
Merge pull request #14734 from hameerabbasi/nep-usage-section
DOC: Edit NEP procedure for better discussion
Diffstat (limited to 'doc/neps')
| -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 ------------ |