summaryrefslogtreecommitdiff
path: root/doc/release
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2019-12-02 19:46:00 -0800
committerGitHub <noreply@github.com>2019-12-02 19:46:00 -0800
commit3a9a63f81aa37b48bc3eb4efdc2e695210805aa5 (patch)
tree7ee7391f2d7214878a56c76d2e4a2d42a835f65a /doc/release
parent7999f7c038a50d79b06edf2d45eb5ff2c25a5a42 (diff)
parent9b4d0ac95d178409d030a4c77651f8ed1d305dea (diff)
downloadnumpy-3a9a63f81aa37b48bc3eb4efdc2e695210805aa5.tar.gz
Merge pull request #14794 from mattip/nep-0034-impl
DEP: issue deprecation warning when creating ragged array (NEP 34)
Diffstat (limited to 'doc/release')
-rw-r--r--doc/release/upcoming_changes/14794.deprecation.rst7
-rw-r--r--doc/release/upcoming_changes/template.rst1
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/14794.deprecation.rst b/doc/release/upcoming_changes/14794.deprecation.rst
new file mode 100644
index 000000000..b84bc1c61
--- /dev/null
+++ b/doc/release/upcoming_changes/14794.deprecation.rst
@@ -0,0 +1,7 @@
+Deprecate automatic ``dtype=object`` for ragged input
+-----------------------------------------------------
+Calling ``np.array([[1, [1, 2, 3]])`` will issue a ``DeprecationWarning`` as
+per `NEP 34`_. Users should explicitly use ``dtype=object`` to avoid the
+warning.
+
+.. _`NEP 34`: https://numpy.org/neps/nep-0034.html
diff --git a/doc/release/upcoming_changes/template.rst b/doc/release/upcoming_changes/template.rst
index 9c8a3b5fc..997b4850e 100644
--- a/doc/release/upcoming_changes/template.rst
+++ b/doc/release/upcoming_changes/template.rst
@@ -17,6 +17,7 @@
{% if definitions[category]['showcontent'] %}
{% for text, values in sections[section][category].items() %}
{{ text }}
+
{{ get_indent(text) }}({{values|join(', ') }})
{% endfor %}