summaryrefslogtreecommitdiff
path: root/doc/release
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2020-01-20 09:19:43 +1100
committermattip <matti.picus@gmail.com>2020-01-20 09:19:43 +1100
commit3404a2c089d304ec107e9d8ea092fb4146d6e0b0 (patch)
tree02e864a57d394c598c9e4964cba84ca95511fb0a /doc/release
parent06a19d6a362af2508d1e11dce47eb2d18a419383 (diff)
downloadnumpy-3404a2c089d304ec107e9d8ea092fb4146d6e0b0.tar.gz
DOC: reword release note to unbreak sphinx rendering
Diffstat (limited to 'doc/release')
-rw-r--r--doc/release/upcoming_changes/15217.deprecation.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/release/upcoming_changes/15217.deprecation.rst b/doc/release/upcoming_changes/15217.deprecation.rst
index e9dd0995d..d49de20b5 100644
--- a/doc/release/upcoming_changes/15217.deprecation.rst
+++ b/doc/release/upcoming_changes/15217.deprecation.rst
@@ -1,11 +1,13 @@
Passing ``shape=0`` to factory functions in ``numpy.rec`` is deprecated
-----------------------------------------------------------------------
-``0`` is treated as a special case by these functions, which aliases to
-``None``. In future, ``0`` will not be a special case, and will be treated
-as an array length like any other integer is. The affected functions are:
+``0`` is treated as a special case and is aliased to ``None`` in the functions:
* `numpy.core.records.fromarrays`
* `numpy.core.records.fromrecords`
* `numpy.core.records.fromstring`
* `numpy.core.records.fromfile`
+
+In future, ``0`` will not be special cased, and will be treated as an array
+length like any other integer.
+