diff options
| author | Ralf Gommers <ralf.gommers@gmail.com> | 2021-02-28 22:41:33 +0100 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@gmail.com> | 2021-02-28 22:41:33 +0100 |
| commit | 5fcf88f933503296735a42c12b17f595aed3d07e (patch) | |
| tree | 77afa6d0c86afbb17a458ed942f0efbf058288b6 | |
| parent | 48ad82dd5cbcfa963e00d22c9cf21edeef623e66 (diff) | |
| download | numpy-5fcf88f933503296735a42c12b17f595aed3d07e.tar.gz | |
DOC: address a few more review comments on downstream packaging guide
[ci skip]
| -rw-r--r-- | doc/source/user/depending_on_numpy.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/source/user/depending_on_numpy.rst b/doc/source/user/depending_on_numpy.rst index a892e8b6d..4cf272d09 100644 --- a/doc/source/user/depending_on_numpy.rst +++ b/doc/source/user/depending_on_numpy.rst @@ -19,8 +19,8 @@ deprecated code. *Bugfix* releases are made even more frequently; they do not contain any new features or deprecations. It is important to know that NumPy, like Python itself and most other -well-known scientific Python projects, does **not** use semantic versioning. -Instead, backwards-incompatible API changes require deprecation warnings for at +well known scientific Python projects, does **not** use semantic versioning. +Instead, backwards incompatible API changes require deprecation warnings for at least two releases. For more details, see :ref:`NEP23`. NumPy has both a Python API and a C API. The C API can be used directly or via @@ -39,10 +39,8 @@ testing against the development version of NumPy in CI. To make this easy, nightly builds are provided as wheels at https://anaconda.org/scipy-wheels-nightly/. This helps detect regressions in NumPy that need fixing before the next NumPy -release. - -Furthermore, we recommend to raise errors on warnings in CI for this job, -either all warnings or otherwise at least ``DeprecationWarning`` and +release. Furthermore, we recommend to raise errors on warnings in CI for this +job, either all warnings or otherwise at least ``DeprecationWarning`` and ``FutureWarning``. This gives you an early warning about changes in NumPy to adapt your code. @@ -55,7 +53,7 @@ Build-time dependency If a package either uses the NumPy C API directly or it uses some other tool that depends on it like Cython or Pythran, NumPy is a *build-time* dependency -of the package. Because the NumPy ABI is only forward-compatible, you must +of the package. Because the NumPy ABI is only forward compatible, you must build your own binaries (wheels or other package formats) against the lowest NumPy version that you support (or an even older version). |