summaryrefslogtreecommitdiff
path: root/numpy/lib/function_base.py
diff options
context:
space:
mode:
authorMelissa Weber Mendonca <melissawm@gmail.com>2020-04-13 17:18:26 -0300
committerMelissa Weber Mendonca <melissawm@gmail.com>2020-04-13 17:18:26 -0300
commit3190b791cbba9712ba1415f9a83fa4583ef3943d (patch)
treee23bc0779afc265b8aa11f7b9908494585f3ad9a /numpy/lib/function_base.py
parentefa7bad30d92f5f58448e753b3d280d3bea157be (diff)
downloadnumpy-3190b791cbba9712ba1415f9a83fa4583ef3943d.tar.gz
Added note to angle function docstring about angle(0) being 0.
Diffstat (limited to 'numpy/lib/function_base.py')
-rw-r--r--numpy/lib/function_base.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py
index bfcf0d316..7eeed7825 100644
--- a/numpy/lib/function_base.py
+++ b/numpy/lib/function_base.py
@@ -1429,6 +1429,11 @@ def angle(z, deg=False):
arctan2
absolute
+ Notes
+ -----
+ Although the angle of the complex number 0 is undefined, ``numpy.angle(0)``
+ returns the value 0.
+
Examples
--------
>>> np.angle([1.0, 1.0j, 1+1j]) # in radians