summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2021-01-23 17:27:17 +0000
committerGitHub <noreply@github.com>2021-01-23 17:27:17 +0000
commitffde0de1c87a07b1dd98b5563c97801d95db713d (patch)
tree253c3cba94541d276e55cfc75e3d0bd551f04f37
parentf9e939b34dfd5196dc77cff2f0123a5c958ecc7f (diff)
downloadnumpy-ffde0de1c87a07b1dd98b5563c97801d95db713d.tar.gz
Commit code review suggestions by seberg
[ci skip] Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>
-rw-r--r--doc/neps/nep-0023-backwards-compatibility.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/neps/nep-0023-backwards-compatibility.rst b/doc/neps/nep-0023-backwards-compatibility.rst
index d4f77a797..a034a01f5 100644
--- a/doc/neps/nep-0023-backwards-compatibility.rst
+++ b/doc/neps/nep-0023-backwards-compatibility.rst
@@ -52,15 +52,16 @@ General principles
When considering proposed changes that are backwards incompatible, the
main principles the NumPy developers use when making a decision are:
-1. Changes need to benefit users more than they harm them.
+1. Changes need to benefit more than they harm users.
2. NumPy is widely used so breaking changes should by default be assumed to be
fairly harmful.
-3. Decisions should be based on data and actual effects on users and downstream
- packages rather than, e.g., appealing to the docs or for stylistic reasons.
-4. Silently getting a wrong answer is much worse than getting a loud error.
+3. Decisions should be based on how they affect users and downstream packages.
+ This should be based on usage data where possible. It does not matter whether
+ this use contradicts the documentation or best practices.
+4. The possibility of an incorrect result is much worse than an error or even crash.
When assessing the costs of proposed changes, keep in mind that most users do
-not read the mailing list, do not look at deprecation warnings, and sometimes
+not read the mailing list, do not notice deprecation warnings, and sometimes
wait more than one or two years before upgrading from their old version. And
that NumPy has millions of users, so "no one will do or use this" is very
likely incorrect.