summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Berg <sebastianb@nvidia.com>2022-11-17 14:52:47 +0100
committerSebastian Berg <sebastianb@nvidia.com>2022-11-17 14:52:47 +0100
commit8b13c8cecf8f049736c33e1a500da0e411b06b53 (patch)
tree6897b7904557b04d3777f82cec5396b047d7bb30
parent49bb24e56f12c44aad2389ecb4559bc6cedbf4e5 (diff)
downloadnumpy-8b13c8cecf8f049736c33e1a500da0e411b06b53.tar.gz
DOC: Document scalar type alias deprecation changes and futurewarning
-rw-r--r--doc/release/upcoming_changes/22607.deprecation.rst5
-rw-r--r--doc/release/upcoming_changes/22607.expired.rst4
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/22607.deprecation.rst b/doc/release/upcoming_changes/22607.deprecation.rst
new file mode 100644
index 000000000..26eb58d20
--- /dev/null
+++ b/doc/release/upcoming_changes/22607.deprecation.rst
@@ -0,0 +1,5 @@
+``np.str0`` and similar are now deprecated
+------------------------------------------
+The scalar type aliases ending in a 0 bit size: ``np.object0``, ``np.str0``,
+``np.bytes0``, ``np.void0``, ``np.int0``, ``np.uint0`` as well as ``np.bool8``
+are now deprecated and will eventually be removed.
diff --git a/doc/release/upcoming_changes/22607.expired.rst b/doc/release/upcoming_changes/22607.expired.rst
new file mode 100644
index 000000000..8c7ea2394
--- /dev/null
+++ b/doc/release/upcoming_changes/22607.expired.rst
@@ -0,0 +1,4 @@
+* The deprecation for the aliases ``np.object``, ``np.bool``, ``np.float``,
+ ``np.complex``, ``np.str``, and ``np.int`` is expired (introduces NumPy 1.20).
+ Some of these will now give a FutureWarning in addition to raising an error
+ since they will be mapped to the NumPy scalars in the future.