summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2020-06-29 14:35:27 -0700
committerRoss Barnowski <rossbar@berkeley.edu>2020-06-29 14:35:27 -0700
commitf565dc6647cf0456939f2ef8de920ef585569160 (patch)
tree7399c661c3f62178ae00e038e84cfcc6e60f2839
parent19f91f3935069229bbc23bbda4294c36957901a5 (diff)
downloadnumpy-f565dc6647cf0456939f2ef8de920ef585569160.tar.gz
DOC: Add dep directive to alen docstring.
alen was deprecated in 1.18. Adds corresponding directive to the docstring to make this information more visible to the user.
-rw-r--r--numpy/core/fromnumeric.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py
index 412d9fe6a..c1a220dfd 100644
--- a/numpy/core/fromnumeric.py
+++ b/numpy/core/fromnumeric.py
@@ -2850,6 +2850,9 @@ def alen(a):
"""
Return the length of the first dimension of the input array.
+ .. deprecated:: 1.18
+ `numpy.alen` is deprecated, use `len` instead.
+
Parameters
----------
a : array_like