Merge pull request numpy#15968 from melissawm/angle-docs

DOC: Added note to angle function docstring about angle(0) being 0.
merraksh · Apr 14, 2020 · c6916f4 · c6916f4
2 parents efa7bad + 3190b79
commit c6916f4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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