diff options
| author | Hameer Abbasi <einstein.edison@gmail.com> | 2019-10-26 12:25:04 +0200 |
|---|---|---|
| committer | Hameer Abbasi <einstein.edison@gmail.com> | 2019-10-26 12:25:04 +0200 |
| commit | f547ce71d56f49cb67a1ea93ae491a188b332bfc (patch) | |
| tree | f6faebee5d27df7f26bdd9baf6be8127c217348c /doc | |
| parent | 7b9b41a4c7dbd7b719d62f343f57f841f5809693 (diff) | |
| download | numpy-f547ce71d56f49cb67a1ea93ae491a188b332bfc.tar.gz | |
Make changes to NEP procedure
as suggested by @stefanv in #14734
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/neps/nep-0000.rst | 13 | ||||
| -rw-r--r-- | doc/neps/nep-template.rst | 5 |
2 files changed, 8 insertions, 10 deletions
diff --git a/doc/neps/nep-0000.rst b/doc/neps/nep-0000.rst index 090c4850e..0a2dbdefb 100644 --- a/doc/neps/nep-0000.rst +++ b/doc/neps/nep-0000.rst @@ -75,14 +75,11 @@ request`_ to the ``doc/neps`` directory with the name ``nep-<n>.rst`` 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. 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. +Once the PR for the NEP is in place, a post should be made to the +mailing list containing the sections upto "Backward compatibility", +with the purpose of limiting discussion there to usage and impact. +Discussion on the pull request will have a broader scope, also including +details of implementation. 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 55a872ca9..42f717c7a 100644 --- a/doc/neps/nep-template.rst +++ b/doc/neps/nep-template.rst @@ -41,8 +41,9 @@ 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. +Its purpose is to provide a high-level summary to users who are not interested +in detailed technical discussion, but may have opinions around, e.g., usage and +impact. Detailed description -------------------- |