summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorSebastian Berg <sebastianb@nvidia.com>2023-04-19 19:55:12 +0200
committerSebastian Berg <sebastianb@nvidia.com>2023-04-20 11:29:59 +0200
commit1a2a1142198db34bd48532f3553c2db97a0f3985 (patch)
tree450b69589b3d3eeceb4f8f53aa8b79f4e5a83dc7 /doc/source
parent4e493065b9ba8a01ebff186f351ac9162af6a220 (diff)
downloadnumpy-1a2a1142198db34bd48532f3553c2db97a0f3985.tar.gz
MAINT,DOC: Update based on Ralf's review
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/dev/depending_on_numpy.rst11
-rw-r--r--doc/source/dev/reviewer_guidelines.rst2
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/source/dev/depending_on_numpy.rst b/doc/source/dev/depending_on_numpy.rst
index 61b279a09..5ef3aafb3 100644
--- a/doc/source/dev/depending_on_numpy.rst
+++ b/doc/source/dev/depending_on_numpy.rst
@@ -48,6 +48,8 @@ job, either all warnings or otherwise at least ``DeprecationWarning`` and
adapt your code.
+.. _depending_on_numpy:
+
Adding a dependency on NumPy
----------------------------
@@ -61,7 +63,8 @@ Build-time dependency
have to compile with the oldest version you wish to support.
This can be done by using
`oldest-supported-numpy <https://github.com/scipy/oldest-supported-numpy/>`__.
- Please see the NumPy 1.24 documentation for further details.
+ Please see the NumPy 1.24 documentation at
+ `https://numpy.org/doc/1.24/dev/depending_on_numpy.html`__.
If a package either uses the NumPy C API directly or it uses some other tool
@@ -72,9 +75,9 @@ By default, NumPy will expose an API that is compatible with at least the
oldest NumPy version that supports the currently oldest compatible Python
version: NumPy 1.25.0 supports Python 3.9 and higher and NumPy 1.19 is the
first version to support Python 3.9. Thus, we will guarantee that version
-(the exact version is set in the headers).
+(the exact version is set within NumPy-internal header files).
-NumPy is also forward compatible for all minor release, but a major release
+NumPy is also forward compatible for all minor releases, but a major release
will require recompilation.
The default behavior can be customized for example by adding::
@@ -93,6 +96,8 @@ version by default you can add::
#endif
Which allows a user to override the default via ``-DNPY_TARGET_VERSION``.
+This define must be consistent for each extension module (use of
+``import_array()``) and also applies to the umath module.
When you compile against NumPy, you should add the proper version restrictions
to your ``pyproject.toml`` (see PEP 517). Since your extension will not be
diff --git a/doc/source/dev/reviewer_guidelines.rst b/doc/source/dev/reviewer_guidelines.rst
index c6b23ebef..2c5d7c1c3 100644
--- a/doc/source/dev/reviewer_guidelines.rst
+++ b/doc/source/dev/reviewer_guidelines.rst
@@ -105,7 +105,7 @@ For maintainers
API Changes
-----------
As mentioned most public API changes should be discussed ahead of time and
-often with a wider audience (mailinglist or even through a NEP).
+often with a wider audience (on the mailing list, or even through a NEP).
For changes in the public C-API be aware that the NumPy C-API is backwards
compatible so that any addition must be ABI compatible with previous versions.