Skip to content

Commit 0524d4c

Browse files
committed
adding a note for real input
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
1 parent f337afa commit 0524d4c

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

docs/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
:nosignatures:
77
:toctree: generated
88
9+
angle
910
apply_where
1011
argpartition
1112
at
@@ -26,5 +27,4 @@
2627
setdiff1d
2728
sinc
2829
union1d
29-
angle
3030
```

src/array_api_extra/_lib/_funcs.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,10 @@ def angle(z: Array, /, *, deg: bool = False, xp: ModuleType | None = None) -> Ar
840840
The counterclockwise angle from the positive real axis on the complex
841841
plane in the range ``(-pi, pi]``.
842842
843+
Notes
844+
-----
845+
A real input x is interpreted as x + 0j
846+
843847
Examples
844848
--------
845849
>>> import array_api_strict as xp

0 commit comments

Comments
 (0)